Skip to content

Commit 4f8114d

Browse files
committed
Update
1 parent c7debf8 commit 4f8114d

File tree

11 files changed

+32
-39
lines changed

11 files changed

+32
-39
lines changed

android-sdk/about.mdx

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,9 @@ For managing static translations in your repository, consider using the [Tolgee
1717

1818
## Overview
1919

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.
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.
2121

22-
**Supports Over‑the‑Air (OTA)** translation updates, seamless integration with Android Views, Jetpack Compose, Compose Multiplatform, and static translation fallbacks.
23-
24-
## Why should you try it?
25-
26-
Tolgee platform lets you ship translations and new languages faster and easier without a new app build.
27-
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.
22+
**Supports Over‑the‑Air (OTA)** translation updates, seamless integration with **Android Views**, **Jetpack Compose**, **Compose Multiplatform**, and **static translation fallbacks**.
2923

3024
## Features
3125

@@ -78,12 +72,6 @@ The platform works offline with caching, fallbacks to static translation resourc
7872
/>
7973
</div>
8074

81-
## Compatibility
82-
83-
:::note
84-
To build configuration examples use Kotlin DSL (build.gradle.kts). Groovy DSL may work but is not officially supported/tested.
85-
:::
86-
8775
## Get Started
8876

8977
Ready to integrate Tolgee into your Android project?
@@ -94,7 +82,7 @@ Ready to integrate Tolgee into your Android project?
9482
emoji="🚀"
9583
description="Complete step-by-step setup guide with installation, modules, and implementation choices"
9684
links={[
97-
{ href: "./get-started", label: "Start Here", color: "blue" }
85+
{ href: "/android-sdk/get-started", label: "Start Here", color: "blue" }
9886
]}
9987
/>
10088
</div>

android-sdk/get-started.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Follow these steps to integrate Tolgee into your Android project and start local
4848
emoji="🚀"
4949
description="Modern declarative UI with reactive translations"
5050
links={[
51-
{ href: "/android-sdk/jetpack/overview", label: "Overview", color: "blue" },
51+
{ href: "/android-sdk/jetpack", label: "Overview", color: "blue" },
5252
{ href: "/android-sdk/jetpack/installation", label: "Installation", color: "green" },
5353
{ href: "/android-sdk/jetpack/usage", label: "Usage", color: "orange" }
5454
]}
@@ -99,5 +99,5 @@ After completing the setup, your app will have:
9999
## Need Help?
100100

101101
- **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)
102+
- **Troubleshooting**: Common issues and diagnostics — [Troubleshooting](./troubleshooting)
103+
- **Demo Apps**: Complete example implementations — [Demo Apps](/android-sdk#demo-apps)

android-sdk/jetpack/installation.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ For managing static translations, we recommend using [Tolgee CLI](https://github
3232
Using **Version Catalog** is recommended to keep your versions aligned, especially in bigger projects. This provides **readability, centralization, and consistency**.
3333
:::
3434

35+
:::note
36+
To build configuration examples use Kotlin DSL (build.gradle.kts). Groovy DSL may work but is not officially supported/tested.
37+
:::
38+
3539
1. Add dependency (Compose):
3640

3741
In `gradle/libs.versions.toml` <u>add an alias for Tolgee Compose library</u>.

android-sdk/jetpack/overview.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Transform your Jetpack Compose or Compose Multiplatform app with dynamic transla
3232
emoji="📦"
3333
description="Set up Tolgee Compose dependencies and configuration"
3434
links={[
35-
{ href: "./installation", label: "Install Guide", color: "blue" }
35+
{ href: "/android-sdk/jetpack/installation", label: "Install Guide", color: "blue" }
3636
]}
3737
/>
3838

@@ -98,13 +98,13 @@ Explore our complete Jetpack Compose demo to see all features in action:
9898

9999
## Integration Path
100100

101-
1. **[Quickstart](./installation)** - Add Compose-specific dependencies
101+
1. **[Quickstart](/android-sdk/jetpack/installation)** - Add Compose-specific dependencies
102102
2. **[Usage Patterns](./usage)** - Learn Compose integration patterns
103-
3. **[Production Setup](../production)** - Configure for deployment
103+
3. **[Production Setup](/android-sdk/production)** - Configure for deployment
104104
4. **[Troubleshooting](./troubleshooting)** - Resolve integration issues
105105

106106
## Need Help?
107107

108108
- Check our **[Troubleshooting Guide](./troubleshooting)** for Compose-specific issues
109109
- Explore the **[Complete Demo](https://github.com/tolgee/tolgee-mobile-kotlin-sdk/tree/master/demo/examplejetpack)** for implementation examples
110-
- Review **[Production Guide](../production)** for deployment best practices
110+
- Review **[Production Guide](/android-sdk/production)** for deployment best practices

android-sdk/quickstart.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ The **Core module** is a Kotlin Multiplatform library that provides runtime supp
3232
Using **Version Catalog** is recommended to keep your versions aligned, especially in bigger projects. This provides **readability, centralization, and consistency**.
3333
:::
3434

35+
:::note
36+
To build configuration examples use Kotlin DSL (build.gradle.kts). Groovy DSL may work but is not officially supported/tested.
37+
:::
38+
3539
1. Add dependency (Core):
3640

3741
In `gradle/libs.versions.toml` <u>add an alias for Tolgee library</u>.

android-sdk/troubleshooting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Expect HTTP 200. For 403/404, re‑copy the prefix and check project permissions
5656

5757
## Useful links
5858

59-
- Installation: [Installation](./installation.mdx)
59+
- Installation: [Quickstart](./quickstart.mdx)
6060
- Usage (Views): [Usage](./usage.mdx)
6161
- Jetpack Compose: [Installation](./jetpack/installation.mdx), [Usage](./jetpack/usage.mdx)
6262
- CLI for static strings: [Tolgee CLI](/tolgee-cli/installation)

platform/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Yes. Tolgee provides a native [iOS SDK](/ios-sdk) that integrates with your app
3232

3333
Yes. Tolgee provides a native [Android SDK](/android-sdk) that integrates with your app and supports Jetpack Compose.
3434

35-
- Get started: [Installation](/android-sdk/installation)
35+
- Get started: [Quickstart](/android-sdk/quickstart)
3636
- Use translations: [Usage](/android-sdk/usage)
3737
- Compose UI: [Jetpack Compose](/android-sdk/jetpack/installation)
3838
- File format details: [Android Resources XML](/platform/formats/android_xml)

platform/formats/android_xml.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Tolgee.init {
8686

8787
See also:
8888

89-
- Android SDK: [Installation](/android-sdk/installation) · [Usage](/android-sdk/usage) · [Jetpack Compose](/android-sdk/jetpack/installation)
89+
- Android SDK: [Quickstart](/android-sdk/quickstart) · [Usage](/android-sdk/usage) · [Jetpack Compose](/android-sdk/jetpack/installation)
9090

9191
## Array support
9292
When importing data to Tolgee from the Android XML files, the array elements are converted into flat keys with

platform/getting_started/translation_content.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ Tolgee provides a native [iOS SDK](/ios-sdk) with a great support for SwiftUI th
3838

3939
Tolgee also provides an [Android SDK](/android-sdk) for native Android apps, including Jetpack Compose support. Follow the Android docs to:
4040

41-
- Install and initialize the SDK: [Installation](/android-sdk/installation)
41+
- Install and initialize the SDK: [Quickstart](/android-sdk/quickstart)
4242
- Use translations in Views and handle plurals/parameters: [Usage](/android-sdk/usage)
4343
- Use localized composables: [Jetpack Compose](/android-sdk/jetpack/installation)
4444

45-
In production, configure content delivery (CDN) using the Android [Installation](/android-sdk/installation) and [Production guide](/android-sdk/production), and preload data as needed.
45+
In production, configure content delivery (CDN) using the Android [Quickstart](/android-sdk/quickstart) and [Production guide](/android-sdk/production), and preload data as needed.

sidebarAndroidSdk.js

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,9 @@
11
module.exports = {
22
someSidebar: [
33
'about',
4-
{
5-
type: 'category',
6-
label: 'Get started',
7-
link: {
8-
type: 'doc',
9-
id: 'get-started',
10-
},
11-
items: ['quickstart', 'modules'],
12-
},
4+
'get-started',
5+
'quickstart',
6+
'modules',
137
'usage',
148
{
159
type: 'category',

0 commit comments

Comments
 (0)