Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add FAQ section #262

Merged
merged 1 commit into from
Jan 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions website/docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
description: Explore the Crowdin iOS SDK FAQ page for quick answers to your questions. Find troubleshooting tips to optimize your experience.
---

# FAQ

### Is there a caching mechanism in the SDK?

Yes, the SDK caches translations locally. The cache TTL can be configured by the developer. There is also a CDN cache. There is not much control over it, but it is usually 1 hour, so there is a possible delay for new translations to appear in the app.

### What translations will be displayed if the current locale is not present in the Crowdin project?

The app will use the bundled translations or the default language as a fallback. It will not fall back to any other Crowdin locale.

### Will the SDK download all translations from Crowdin every time the app launches?

No, the SDK downloads and caches translations locally. It will only download translations if they are not in the cache or if the cache has expired.

### Will the SDK download all translations from the Crowdin CDN or just the current language?

The SDK downloads only the current language translations.

### How do I test the new translations before releasing the distribution?

You can use the Real-Time Preview feature for this. After authorization, it will download the latest translations from the Crowdin project, which can be tested before delivering all translations to users. You can also create a new distribution and test it before releasing the main distribution.

### What format is used to transfer translations from Crowdin to the app?

The translations are transferred in the same format as they are stored in the Crowdin project.

### What translations will be displayed if I lose my Internet connection?

The SDK uses the cached translations. If there are no cached translations, it will use the bundled translations or the default language as a fallback.

### If there are multiple branches in the Crowdin project, which translations will be displayed in the app?

The SDK will use the translations from the branch that is specified in the distribution configuration.
3 changes: 2 additions & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
@@ -40,7 +40,8 @@ const sidebars = {
]
},
'example',
'security'
'security',
'faq'
],
};