Skip to content

Commit 0013220

Browse files
committed
docs: add Quickstart, Usage, and Troubleshooting guides for Core Module
1 parent 6e55fee commit 0013220

File tree

4 files changed

+23
-12
lines changed

4 files changed

+23
-12
lines changed
File renamed without changes.

android-sdk/troubleshooting.mdx renamed to android-sdk/core-module/troubleshooting.mdx

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
id: troubleshooting
3-
title: Troubleshooting
3+
title: Troubleshooting (Core Module)
44
description: Troubleshooting Tolgee Android SDK
55
---
6+
67
#Troubleshooting (Core Module)
8+
79
## Fast Checklist
810

911
Before diving into troubleshooting, quickly review this list to steer clear of the most common erroes.
@@ -39,11 +41,14 @@ curl -I "https://cdn.tolg.ee/your-cdn-url-prefix/en.json"
3941
- For UI tests, inject a test Tolgee instance with preloaded data.
4042

4143
## Common Issues
44+
4245
**1. Dependency Issues**
46+
4347
- Make sure Maven Central is included in your repositories - check the dependency in your build.gradle.kts.
4448
- If using a Version Catalog, confirm that version.ref = "tolgee" points to the correct version.
4549

4650
**2. Translation Issues**
51+
4752
- Check that your Tolgee instance is properly initialized (in Application with applicationContext).
4853
- Verify CDN URL prefix in Tolgee Platform.
4954
- Check that your storage provider is properly configured
@@ -52,38 +57,41 @@ curl -I "https://cdn.tolg.ee/your-cdn-url-prefix/en.json"
5257
- Use tolgee.preload or tolgee.tFlow before calling tolgee.t to ensure translations are loaded.
5358

5459
**3. Network Security Issues**
60+
5561
- Add a network_security.xml in your res/xml folder (You can reference it in AndroidManifest.xml).
5662

5763
**4. Locale Issues**
64+
5865
- Use tolgee.changeFlow to monitor locale changes and update your UI accordingly.
5966
- Call tolgee.preload(this) function for critical screens (e.g., login, onboarding).
6067
- Verify that your project supports the locale code you're using.
6168
- Check that translations for the selected locale exist in your Tolgee project.
6269
- Use a mock or explicit instance for tests/previews.
6370

64-
***5. Plurals & Formatting Issues**
71+
**\*5. Plurals & Formatting Issues**
72+
6573
- Make sure plural resources exist both in Android (plurals.xml) and Tolgee Platform.
6674
- Use the correct formatter (Sprintf vs ICU).
6775
- Ensure translations in Tolgee Platform match the expected format style.
6876

6977
See also: [Android XML format](/platform/formats/android_xml) · [Tolgee Universal ICU placeholders](/platform/translation_process/tolgee_universal_icu_placeholders)
7078

71-
7279
**6. Android Resource Integration Issues**
80+
7381
- Check that your Android resources are properly structured - Tolgee is using resources.getResourceEntryName to find key for the resource.
7482
- Make sure the Tolgee instance has access to the Android application context.
7583
- Ensure that the TolgeeStorageProviderAndroid is properly initialized with the context and version code which changes with each app update.
7684

7785
**7. Multiplatform (KMP) Issues**
86+
7887
- Verify that your resource files are correctly set up and all strings present in resources are also in Tolgee Platform.
7988
- Make sure that you are using the correct resource references.
8089

81-
8290
## Useful links
8391

8492
- Installation: [Quickstart](./quickstart.mdx)
8593
- Usage (Views): [Usage](./usage.mdx)
8694
- For complete examples of how to use the Tolgee Core module, check out the demo projects:
87-
Traditional Android Views example - https://github.com/tolgee/tolgee-mobile-kotlin-sdk/tree/master/demo/exampleandroid
95+
Traditional Android Views example - https://github.com/tolgee/tolgee-mobile-kotlin-sdk/tree/master/demo/exampleandroid
8896
- Jetpack Compose: [Installation](./jetpack/installation.mdx), [Usage](./jetpack/usage.mdx)
8997
- CLI for static strings: [Tolgee CLI](/tolgee-cli/installation)
File renamed without changes.

sidebarAndroidSdk.js

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,25 @@ module.exports = {
22
someSidebar: [
33
'about',
44
'get-started',
5-
'quickstart',
6-
'usage',
5+
{
6+
type: 'category',
7+
label: 'Core Module',
8+
items: [
9+
'core-module/quickstart',
10+
'core-module/usage',
11+
'core-module/troubleshooting',
12+
],
13+
},
14+
715
{
816
type: 'category',
917
label: 'Jetpack Compose',
10-
link: {
11-
type: 'doc',
12-
id: 'jetpack/overview',
13-
},
1418
items: [
1519
'jetpack/installation',
1620
'jetpack/usage',
1721
'jetpack/troubleshooting',
1822
],
1923
},
2024
'reccomendations',
21-
'troubleshooting',
2225
],
2326
};

0 commit comments

Comments
 (0)