docs: expand Android SDK overview with detailed features and benefits #1005
Conversation
✅ Deploy Preview for tolgee-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
dzienisz
force-pushed
the
feat/android-about
branch
from
2396e3d to
5fa2a5d
Compare
dzienisz
requested review from
Anty0,
NazariiOliinyk,
ZuzanaOdstrcilova and
dkrizan
dzienisz
force-pushed
the
feat/android-about
branch
from
7dd2bf8 to
ae6b404
Compare
dzienisz
force-pushed
the
feat/android-about
branch
9 times, most recently
from
b53bf00 to
aeeddd3
Compare
dzienisz
force-pushed
the
feat/android-about
branch
from
60f37e1 to
74ebcc5
Compare
There was a problem hiding this comment.
I reviewed the correctness of the info as requested. If there was anything obvious about its appearance, I commented on it too, but it wasn't my main concern. Let's explore how to improve accuracy in the future without my reviews—maybe create a list of things you're unsure about so I can help answer them. It's much easier for me to answer questions than to find inaccuracies in documentation changes like these—especially since a lot of info repeats multiple times. Otherwise, the first impression is definitely better, and I like how it looks from a distance. It still feels quite generated and feels like reading marketing material more than documentation, but we can work on that.
|
It appears that the comments on moved files are missing the lines they reference. Let me know if any of them don't provide enough context to understand what they refer to. I'll locate what they referred to and recreate the comment. |
dzienisz
force-pushed
the
feat/android-about
branch
from
0dd54ac to
f3475f1
Compare
…n Android SDK docs
…r steps and improved structure
… clearer sections
…oid SDK usage guide
dzienisz
force-pushed
the
feat/android-about
branch
from
335ba9a to
d19c5f1
Compare
dzienisz
requested review from
NazariiOliinyk
and removed request for
NazariiOliinyk
|
|
||
| Once integrated, the SDK handles fetching and applying translations dynamically, so developers no longer need to manually manage string resources, export localization files, or coordinate translation updates through app releases. | ||
|
|
||
| The SDK integrates seamlessly with both **Android Views** and **Jetpack Compose**, supports reactive locale changes, and is built with **Kotlin Multiplatform** compatibility in mind. |
There was a problem hiding this comment.
@Anty0 Can you please review this paragraph. I am not sure what reactive locale changes means. Maybe it's accurate. I don't have enough expertise to judge this.
|
|
||
| ### Over-the-Air (OTA) Content Delivery | ||
|
|
||
| Update translations dynamically at runtime. Save a lot of time when releasing new or updated translations. No need to wait for them to be published via Google Play or App Store. |
There was a problem hiding this comment.
We don't communicate in imperative in the docs, instead we use indicative.
This is too marketingish phrasing. I think we should keep the informative tone, not the "action" one.
"Tolgee Android SDK enables you to...", "This way, you can save a lot of time"
|
|
||
| ### Compose integration | ||
|
|
||
| Full integration with Jetpack Compose and Compose Multiplatform |
There was a problem hiding this comment.
@Anty0 Maybe you can provide some suggestions what to mention there.
|
|
||
| ### Kotlin Multiplatform support | ||
|
|
||
| Designed with multiplatform projects in mind. |
There was a problem hiding this comment.
@Anty0 Maybe you can provide some suggestions what to mention there.
|
|
||
| ### Flexible hosting options | ||
|
|
||
| Connect to [Tolgee Cloud](/platform/) or [self-hosted](/platform/self_hosting/getting_started) instances. |
There was a problem hiding this comment.
This is default. I would not mention this. There is no integration working only with cloud or self-hosted and this might lead to some confusion that we might sometime prioritize the cloud.
| In this section, the translation types are demonstrated. Here you can see a quick overview: | ||
|
|
||
| 3) (If preferred) Recreate the Activity when translations change: | ||
| :::note |
There was a problem hiding this comment.
I would remove this note.
| Returns null if translations are not yet loaded (e.g., SDK hasn't downloaded data). | ||
| Returns a key when translations are loaded. | ||
|
|
||
| **Use for simple/static text** (e. g., error messages, titles). |
There was a problem hiding this comment.
Instead of specifying the right use case after the code, you should do it before the code. Then you would not need the note. I would expect sentence like
"One time translation is useful when..." or "To translate simple/static text ..., you can use the tolgee.t" method.
Please fix this everywhere.
| @@ -0,0 +1,49 @@ | |||
| --- | |||
| id: overview | |||
| title: Overview | |||
There was a problem hiding this comment.
The title of the page is indexed by browsers and is visible as the title of the tab in the browser. Should be: Android SDK Overview.
|
|
||
| Ensure you have completed the quickstart guide and initialized Tolgee in your Application class. See: [Installation](./installation.mdx) | ||
|
|
||
| ## Get The Global Tolgee Instance |
There was a problem hiding this comment.
Nowhere in the usage page I cannot see any information about the fact, that you usually don't need to get the Tolgee instance and you simply can use the standard android approach and it wil work. Is it like that @Anty0?
| Tolgee.init { | ||
| contentDelivery { | ||
| url = "https://cdn.tolg.ee/your-cdn-url-prefix" | ||
| format(Tolgee.Formatter.ICU) |
There was a problem hiding this comment.
@Anty0 What is the state about the ICU formatter? I thought that we agreed, we're not going to mention it at all.
4 participants
Uh oh!
There was an error while loading. Please reload this page.