Skip to content

Commit c76b406

Browse files
docs: upgrade dependencies, minor improvements to the content (#344)
1 parent a654ec2 commit c76b406

9 files changed

Lines changed: 3305 additions & 2840 deletions

File tree

.github/workflows/docs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ jobs:
1010
build-and-deploy-docs:
1111
runs-on: ubuntu-latest
1212
steps:
13-
- uses: actions/checkout@v4
13+
- uses: actions/checkout@v6
1414

1515
- name: Setup Node.js
16-
uses: actions/setup-node@v4
16+
uses: actions/setup-node@v6
1717
with:
18-
node-version: 20
18+
node-version: 22
1919

2020
- name: Install docs dependencies
2121
working-directory: website

website/docs/advanced-features/jetpack-compose.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,4 +103,4 @@ fun Greeting() {
103103

104104
### See also
105105

106-
- [Real-Time Preview](real-time-preview.mdx)
106+
- [Real-Time Preview](real-time-preview)

website/docs/advanced-features/real-time-preview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ import samplePreviewDisconnectJava from '!!raw-loader!../code-samples/real-time-
4343
:::tip Tips
4444
- To use the Real-Time Preview feature you still need to [wrap context](/setup#context-wrapping) for your activities.
4545
- To easily control the Real-Time Preview feature you could also use the [SDK Controls](/advanced-features/sdk-controls) UI widget.
46-
- For Jetpack Compose applications, see [Jetpack Compose Realtime Support](jetpack-compose.mdx).
46+
- For Jetpack Compose applications, see [Jetpack Compose Realtime Support](jetpack-compose).
4747
:::
4848

4949
### Config options

website/docs/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ implementation ('com.github.crowdin.mobile-sdk-android:sdk:1.17.0') {
3939

4040
## See also
4141

42-
- [Setup](setup.mdx)
42+
- [Setup](setup)

website/docs/intro.mdx

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,17 +50,6 @@ Translators can instantly preview translations they are making in Crowdin on the
5050

5151
Project owner and managers can make screenshots right within the app version where this component is enabled. Screenshots will automatically appear in the project with tagged source strings.
5252

53-
## Bundles
54-
55-
Bundles allow you to generate resource files from your project strings. You can upload strings to Crowdin in any format (e.g. spreadsheet file) or create keys using the Figma plugin. Then use bundles to generate resource files to be used in your mobile or web application in any format.
56-
57-
By default, you can choose from the following three formats: Android XML, iOS Strings, and XLIFF. You can add more target file formats by installing respective applications from the [Crowdin Store](https://store.crowdin.com/tags/string-exporter).
58-
59-
For more details, visit Knowledge Base:
60-
61-
- [Bundles in OTA Content Delivery (crowdin.com)](https://support.crowdin.com/bundles/#bundles-in-ota-content-delivery)
62-
- [Bundles in OTA Content Delivery (Crowdin Enterprise)](https://support.crowdin.com/enterprise/bundles/#bundles-in-ota-content-delivery)
63-
6453
## See also
6554

6655
- [Installation](installation)

website/docs/setup.mdx

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,26 @@ import CodeBlock from '@theme/CodeBlock';
44

55
# Setup
66

7-
To configure Android SDK integration you need to:
7+
To configure Android SDK integration, you need to:
88

99
- Upload your localization files to Crowdin. If you have existing translations, you can upload them as well. You can use one of the following options:
1010
- [Crowdin CLI](https://crowdin.github.io/crowdin-cli/)
1111
- [Android Studio Plugin](https://store.crowdin.com/android-studio)
1212
- [Crowdin GitHub Action](https://github.com/marketplace/actions/crowdin-action)
1313
- [and more](https://support.crowdin.com/uploading-files/)
14-
- Set up Distribution in Crowdin.
14+
- Set up a distribution in Crowdin.
1515
- Set up SDK and enable Over-The-Air Content Delivery feature in your project.
1616

17-
**Distribution** is a CDN vault that mirrors the translated content of your project and is required for integration with Android app.
17+
**Distribution** is a CDN vault that mirrors your project's translated content and is required for Android app integration.
1818

19-
- [Creating a distribution in crowdin.com](https://support.crowdin.com/content-delivery/)
20-
- [Creating a distribution in Crowdin Enterprise](https://support.crowdin.com/enterprise/content-delivery/)
19+
- [Creating a distribution in Crowdin](https://support.crowdin.com/cdn-distributions/)
20+
- [Creating a distribution in Crowdin Enterprise](https://support.crowdin.com/enterprise/cdn-distributions/)
2121

2222
:::info
23-
- By default, the translation downloading happens **asynchronously** after launching the app. The downloaded translations will be used after the next launch of the app or Activity re-render. Otherwise, the [previously cached translations](/cache) will be used (or local translations if a cache does not exist).
24-
- The CDN feature does not update the localization files. if you want to add new translations to the localization files you need to do it yourself.
25-
- Once SDK receives the translations, it's stored on the device as application files for further sessions to minimize requests the next time the app starts. Storage time can be configured using `withUpdateInterval` option.
26-
- CDN caches all the translation in release for up to 1 hour and even when new translations are released in Crowdin, CDN may return it with a delay.
23+
- By default, translation download happens **asynchronously** after app launch. Downloaded translations are applied after the next app launch or activity re-render. Otherwise, [previously cached translations](/cache) are used (or bundled local translations if a cache does not exist).
24+
- The CDN feature does not update your localization files. If you want to add new translations to localization files, update them separately.
25+
- Once the SDK receives translations, they are stored on the device as application files for future sessions to minimize requests. Storage time can be configured using the `withUpdateInterval` option.
26+
- CDN caches released translations for up to 1 hour, so newly released translations in Crowdin may be returned with a delay.
2727
- To display a string, Crowdin will try to find it in the dynamic strings (from the CDN) and use the bundled version as a fallback. In other words, only the newly provided strings will be overridden and the bundled version will be used for the rest.
2828
:::
2929

@@ -179,4 +179,3 @@ Otherwise, new resources are applied when the activity is restarted.
179179
- [Real-Time Preview](advanced-features/real-time-preview)
180180
- [Screenshots](advanced-features/screenshots)
181181
- [Programmatic String Access](guides/programmatic-strings)
182-

website/docusaurus.config.ts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ const config: Config = {
1414
projectName: 'mobile-sdk-android',
1515

1616
onBrokenLinks: 'throw',
17-
onBrokenMarkdownLinks: 'warn',
17+
markdown: {
18+
hooks: {
19+
onBrokenMarkdownLinks: 'warn',
20+
},
21+
},
1822

1923
i18n: {
2024
defaultLocale: 'en',
@@ -27,7 +31,7 @@ const config: Config = {
2731
({
2832
docs: {
2933
routeBasePath: '/',
30-
sidebarPath: require.resolve('./sidebars.js'),
34+
sidebarPath: require.resolve('./sidebars.ts'),
3135
editUrl: 'https://github.com/crowdin/mobile-sdk-android/tree/master/website/',
3236
},
3337
theme: {
@@ -64,6 +68,9 @@ const config: Config = {
6468
},
6569
],
6670
},
71+
colorMode: {
72+
respectPrefersColorScheme: true,
73+
},
6774
footer: {
6875
style: 'dark',
6976
links: [

0 commit comments

Comments
 (0)