Skip to content

Commit c7debf8

Browse files
dzieniszdzienisz
committed
update
1 parent 0eb414b commit c7debf8

File tree

13 files changed

+376
-180
lines changed

13 files changed

+376
-180
lines changed

‎android-sdk/about.mdx‎

Lines changed: 36 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -2,51 +2,59 @@
22
id: about
33
title: Overview
44
slug: /
5-
description: Overview of Tolgee Android SDK with Over‑the‑Air (OTA) localization updates and how to get started.
5+
description: Overview of Tolgee Mobile SDK with Over‑the‑Air (OTA) localization updates for Android and Compose Multiplatform.
66
---
77

88
import SystemCard from '@site/src/component/SystemCard';
9+
import FeatureGrid from '@site/src/component/FeatureGrid';
910
import Tolgee from '@site/src/component/Tolgee';
1011

11-
# Tolgee Android SDK
12+
# Tolgee Mobile SDK
1213

1314
:::info
1415
For managing static translations in your repository, consider using the [Tolgee CLI](/tolgee-cli/installation).
1516
:::
1617

1718
## Overview
1819

19-
Tolgee Android SDK lets you localize Android apps with dynamic content delivery, and lets you provide translations dynamically without needing to publish new app versions.
20+
Tolgee Mobile SDK for Android and Compose Multiplatform lets you localize Kotlin-based applications with dynamic content delivery, providing translations dynamically without needing to publish new app versions.
2021

21-
**Supports Over‑the‑Air (OTA)** translation updates, seamless integration with multiple systems, Android Views, Jetpack Compose and static translations.
22+
**Supports Over‑the‑Air (OTA)** translation updates, seamless integration with Android Views, Jetpack Compose, Compose Multiplatform, and static translation fallbacks.
2223

2324
## Why should you try it?
2425

2526
Tolgee platform lets you ship translations and new languages faster and easier without a new app build.
2627

27-
The platform works offline with caching, fallbacks to Android resources when needed, and preloading critical namespaces for a smooth user experience. Additionally, Tolgee keeps UX consistent by updating the UI automatically in response to translation or locale changes. These features result in fewer untranslated or mismatched strings of text.
28+
The platform works offline with caching, fallbacks to static translation resources when needed, and preloading critical namespaces for a smooth user experience. Additionally, Tolgee keeps UX consistent by updating the UI automatically in response to translation or locale changes. These features result in fewer untranslated or mismatched strings of text.
2829

2930
## Features
3031

31-
### Over‑the‑Air (OTA) updates
32-
33-
Delivers translations via CDN (Cloud or self‑hosting) with caching and offline support.
34-
35-
### Change the app's language at runtime (Runtime locale API)
36-
37-
Use `tolgee.changeFlow` to monitor locale changes and update your UI accordingly.
38-
39-
### Works offline with fallbacks and preloading
40-
41-
Provides fallbacks to Android resources and preloading of critical namespaces.
42-
43-
### Support for Android Views, Jetpack Compose and static translations with CLI
44-
45-
Support for both coding functions `stringResource`, `pluralStringResource` and reactive updates.
46-
47-
### Hosting options
48-
49-
You have multiple hosting options: CDN (Cloud or self‑hosting).
32+
<FeatureGrid features={[
33+
{
34+
emoji: '🚀',
35+
title: 'Over-the-air updates',
36+
description: 'Update your translations without releasing a new app version',
37+
colorTheme: 'blue'
38+
},
39+
{
40+
emoji: '🔧',
41+
title: 'Multiple format support',
42+
description: '• <strong>Sprintf</strong> (Android SDK) formatting<br/>• <strong>ICU</strong> (Tolgee Native Flat JSON) formatting',
43+
colorTheme: 'green'
44+
},
45+
{
46+
emoji: '⚡',
47+
title: 'Compose integration',
48+
description: 'Full integration with Jetpack Compose and Compose Multiplatform',
49+
colorTheme: 'purple'
50+
},
51+
{
52+
emoji: '🌐',
53+
title: 'Kotlin Multiplatform',
54+
description: 'Designed with multiplatform support in mind',
55+
colorTheme: 'orange'
56+
}
57+
]} />
5058

5159
## Demo apps
5260

@@ -78,77 +86,15 @@ To build configuration examples use Kotlin DSL (build.gradle.kts). Groovy DSL ma
7886

7987
## Get Started
8088

81-
Ready to integrate Tolgee into your Android project? Follow this step-by-step guide to add dynamic translations to your app.
82-
83-
### Setup Overview
84-
85-
<div className="grid grid-cols-1 md:grid-cols-2 gap-4 my-6">
86-
<SystemCard
87-
title="Installation"
88-
emoji="📦"
89-
description="Set up dependencies and network security configuration"
90-
links={[
91-
{ href: "./installation", label: "Installation Guide", color: "blue" }
92-
]}
93-
/>
94-
95-
<SystemCard
96-
title="Modules Overview"
97-
emoji="🔧"
98-
description="Choose between Core and Compose modules for your project"
99-
links={[
100-
{ href: "./modules", label: "Modules Guide", color: "green" }
101-
]}
102-
/>
103-
</div>
104-
105-
### Choose Your Implementation
106-
107-
<div className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-4 my-6">
108-
<SystemCard
109-
title="Jetpack Compose"
110-
emoji="🚀"
111-
description="Modern declarative UI with reactive translations"
112-
links={[
113-
{ href: "/android-sdk/jetpack/overview", label: "Overview", color: "blue" },
114-
{ href: "/android-sdk/jetpack/installation", label: "Installation", color: "green" },
115-
{ href: "/android-sdk/jetpack/usage", label: "Usage", color: "orange" }
116-
]}
117-
/>
118-
119-
<SystemCard
120-
title="Android Views"
121-
emoji="📱"
122-
description="Traditional Android UI with dynamic translations"
123-
links={[
124-
{ href: "./usage", label: "Usage Guide", color: "purple" }
125-
]}
126-
/>
127-
128-
<SystemCard
129-
title="CLI Integration"
130-
emoji="⚡"
131-
description="Generate and manage <strong>static translations</strong>"
132-
links={[
133-
{ href: "/tolgee-cli/installation", label: "Tolgee CLI", color: "cyan" }
134-
]}
135-
/>
136-
</div>
137-
138-
### Production Deployment
89+
Ready to integrate Tolgee into your Android project?
13990

14091
<div className="grid grid-cols-1 gap-4 my-6">
14192
<SystemCard
142-
title="Production Guide"
93+
title="Get Started Guide"
14394
emoji="🚀"
144-
description="Over‑the‑Air (OTA) updates, caching, formatting, and testing for production apps"
95+
description="Complete step-by-step setup guide with installation, modules, and implementation choices"
14596
links={[
146-
{ href: "./production", label: "Production Setup", color: "blue" }
97+
{ href: "./get-started", label: "Start Here", color: "blue" }
14798
]}
14899
/>
149100
</div>
150-
151-
### Need Help?
152-
153-
- **Manage translations collaboratively**: Connect your app to the Tolgee Platform — [Platform docs](../platform/)
154-
- **Troubleshooting**: Common issues and diagnostics — [Troubleshooting](./troubleshooting.mdx)

‎android-sdk/get-started.mdx‎

Lines changed: 56 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,24 @@
22
id: get-started
33
title: Get Started
44
slug: /get-started
5-
description: Quick start guide for integrating Tolgee Android SDK into your project
5+
description: Quick start guide for integrating Tolgee Mobile SDK into your project
66
---
77

88
import SystemCard from '@site/src/component/SystemCard';
99

10-
# Get Started with Tolgee Android SDK
10+
# Get Started with Tolgee Mobile SDK
1111

12-
Follow these steps to integrate Tolgee into your Android project and start localizing your app with dynamic translations.
12+
Follow these steps to integrate Tolgee into your Android project and start localizing your app with **dynamic translations**.
1313

1414
## Quick Setup Overview
1515

1616
<div className="grid grid-cols-1 md:grid-cols-2 gap-4 my-6">
1717
<SystemCard
18-
title="Installation"
18+
title="Quickstart"
1919
emoji="📦"
2020
description="Set up dependencies and network security configuration"
2121
links={[
22-
{ href: "./installation", label: "Installation Guide", color: "blue" }
22+
{ href: "./quickstart", label: "Quickstart Guide", color: "blue" }
2323
]}
2424
/>
2525

@@ -35,13 +35,44 @@ Follow these steps to integrate Tolgee into your Android project and start local
3535

3636
## Integration Path
3737

38-
1. **[Installation](./installation)** - Add Tolgee SDK to your project
38+
1. **[Quickstart](./quickstart)** - Add Tolgee SDK to your project
3939
2. **[Modules Overview](./modules)** - Understand Core vs Compose modules
40-
3. **Choose your implementation:**
41-
- **[Android Views](./usage)** - For traditional Android UI
42-
- **[Jetpack Compose](./jetpack/installation)** - For modern Compose UI
40+
3. **Choose your implementation** (see cards below)
4341
4. **[Production Setup](./production)** - Configure for production deployment
4442

43+
## Choose Your Implementation
44+
45+
<div className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-4 my-6">
46+
<SystemCard
47+
title="Jetpack Compose"
48+
emoji="🚀"
49+
description="Modern declarative UI with reactive translations"
50+
links={[
51+
{ href: "/android-sdk/jetpack/overview", label: "Overview", color: "blue" },
52+
{ href: "/android-sdk/jetpack/installation", label: "Installation", color: "green" },
53+
{ href: "/android-sdk/jetpack/usage", label: "Usage", color: "orange" }
54+
]}
55+
/>
56+
57+
<SystemCard
58+
title="Android Views"
59+
emoji="📱"
60+
description="Traditional Android UI with dynamic translations"
61+
links={[
62+
{ href: "./usage", label: "Usage Guide", color: "purple" }
63+
]}
64+
/>
65+
66+
<SystemCard
67+
title="CLI Integration"
68+
emoji="⚡"
69+
description="Generate and manage <strong>static translations</strong>"
70+
links={[
71+
{ href: "/tolgee-cli/installation", label: "Tolgee CLI", color: "cyan" }
72+
]}
73+
/>
74+
</div>
75+
4576
## What You'll Achieve
4677

4778
After completing the setup, your app will have:
@@ -52,8 +83,21 @@ After completing the setup, your app will have:
5283
- ✅ **Fallback support** to bundled Android resources
5384
- ✅ **Over-the-Air updates** for translations without app republishing
5485

86+
## Production Deployment
87+
88+
<div className="grid grid-cols-1 gap-4 my-6">
89+
<SystemCard
90+
title="Production Guide"
91+
emoji="🚀"
92+
description="Over‑the‑Air (OTA) updates, caching, formatting, and testing for production apps"
93+
links={[
94+
{ href: "./production", label: "Production Setup", color: "blue" }
95+
]}
96+
/>
97+
</div>
98+
5599
## Need Help?
56100

57-
- Check our **[Troubleshooting Guide](./troubleshooting)** for common issues
58-
- Explore **[Demo Apps](./about#demo-apps)** for complete examples
59-
- Review **[Production Guide](./production)** for deployment best practices
101+
- **Manage translations collaboratively**: Connect your app to the Tolgee Platform — [Platform docs](../platform/)
102+
- **Troubleshooting**: Common issues and diagnostics — [Troubleshooting](./troubleshooting.mdx)
103+
- **Demo Apps**: Complete example implementations — [Demo Apps](./about#demo-apps)

0 commit comments

Comments
 (0)