Skip to content

Commit f9ec5dd

Browse files
committed
docs: reorganize Android SDK docs into installation, setup and example apps sections
1 parent 57bbeda commit f9ec5dd

File tree

17 files changed

+396
-738
lines changed

17 files changed

+396
-738
lines changed

android-sdk/core-module/quickstart.mdx

Lines changed: 0 additions & 201 deletions
This file was deleted.

android-sdk/core-module/troubleshooting.mdx

Lines changed: 0 additions & 31 deletions
This file was deleted.

android-sdk/example-apps.mdx

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
id: example-apps
3+
title: Example Apps
4+
slug: /example-apps
5+
description: Example apps for Tolgee Android SDK with Over‑the‑Air (OTA) localization updates for Android and Compose Multiplatform.
6+
---
7+
8+
import { ScreenshotWrapper } from '../platform/shared/_ScreenshotWrapper';
9+
10+
# Example Apps
11+
12+
Explore fully functional demo applications showcasing Tolgee Android SDK integration. Each example demonstrates best practices for implementing Over-the-Air translation updates in different Android development environments.
13+
14+
<ScreenshotWrapper
15+
src="/img/docs/sdk/android-studio.png"
16+
alt="Android Studio"
17+
/>
18+
19+
## Android Views Demo
20+
21+
**Perfect for traditional Android development**
22+
23+
A complete reference implementation using classic Android Views and XML layouts. This example demonstrates:
24+
25+
- ✅ One-time and dynamic translation methods
26+
- ✅ Locale switching and change detection
27+
- ✅ Integration with Android string resources
28+
- ✅ Parameter support for dynamic content
29+
- ✅ Proper Application-level initialization
30+
31+
**[View Android Views Example →](https://github.com/tolgee/tolgee-mobile-kotlin-sdk/tree/master/demo/exampleandroid)**
32+
33+
---
34+
35+
## Jetpack Compose Demo
36+
37+
**Modern declarative UI with reactive translations**
38+
39+
A comprehensive example showcasing Tolgee integration with Jetpack Compose. Features include:
40+
41+
-`stringResource()` composables for direct translation
42+
- ✅ Parameter support for dynamic content
43+
- ✅ Reactive UI updates when locale changes
44+
- ✅ Formatter configuration options
45+
- ✅ Integration with Compose state system
46+
47+
**[View Jetpack Compose Example →](https://github.com/tolgee/tolgee-mobile-kotlin-sdk/tree/master/demo/examplejetpack)**
48+
49+
---
50+
51+
## Compose Multiplatform Demo
52+
53+
**Cross-platform translations for Android, iOS, and Desktop**
54+
55+
A full-featured multiplatform application demonstrating Tolgee's Kotlin Multiplatform capabilities:
56+
57+
- ✅ Shared translation logic across platforms
58+
- ✅ Compose Multiplatform UI integration
59+
- ✅ Cross-platform resource handling
60+
- ✅ Common API for all supported platforms
61+
- ✅ Multiplatform development patterns
62+
63+
**[View Compose Multiplatform Example →](https://github.com/tolgee/tolgee-mobile-kotlin-sdk/tree/master/demo/examplecomposemultiplatform)**
64+
65+
---
66+
67+
## Getting Started with Examples
68+
69+
1. **Clone the repository**:
70+
71+
```bash
72+
git clone https://github.com/tolgee/tolgee-mobile-kotlin-sdk.git
73+
```
74+
2. **Navigate to the demo folder**: Choose the example that matches your tech stack
75+
3. **Open in Android Studio**: Import the project and sync Gradle
76+
4. **Configure your CDN URL**: Add your Tolgee project's CDN URL in the initialization code
77+
5. **Run and explore**: See live translation updates in action
78+
79+
:::tip
80+
These examples are actively maintained and updated with each SDK release. They're the best way to learn Tolgee integration patterns and troubleshoot issues.
81+
:::
82+
83+
## Next Steps
84+
85+
- **New to Tolgee?** Start with [Installation](./installation)
86+
- **Need help?** Check [Troubleshooting](./troubleshooting)
87+
- **Ready for production?** See [Production Guide](./production)
88+

android-sdk/get-started.mdx

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)