Skip to content

Commit 66f598e

Browse files
Merge pull request #199 from basketshoe/main
2 parents f0fafa2 + e36770c commit 66f598e

1 file changed

Lines changed: 20 additions & 9 deletions

File tree

i18n/TRANSLATION_GUIDE.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,20 @@ Each language folder follows the same structure:
2424
i18n/[language-code]/
2525
├── docusaurus-plugin-content-docs/
2626
│ └── current/
27-
│ ├── intro.mdx
28-
│ ├── faq.mdx
29-
│ ├── release-notes.mdx
30-
│ ├── advanced/
31-
│ ├── installation/
32-
│ └── troubleshooting/
27+
│ │ ├── intro.mdx
28+
│ │ ├── faq.mdx
29+
│ │ ├── release-notes.mdx
30+
│ │ ├── advanced/
31+
│ │ ├── contributing/
32+
│ │ ├── installation/
33+
│ │ └── troubleshooting/
34+
| └── current.json
3335
├── docusaurus-plugin-content-blog/
34-
└── docusaurus-theme-classic/
36+
| └── options.json
37+
├── docusaurus-theme-classic/
38+
| ├── footer.json
39+
| └── navbar.json
40+
└── code.json
3541
```
3642

3743
## Getting Started
@@ -56,6 +62,11 @@ i18n/[language-code]/
5662

5763
3. **Translation workflow**
5864
- The English files are already present in each language folder and ready for translation
65+
* If your locale is not present in the i18n directory, open the terminal in /path/to/SideStore-Docs and run
66+
```bash
67+
yarn write-translations --locale [language-code]
68+
```
69+
then copy the docs directory into `/i18n/[language-code]/docusaurus-plugin-content-docs/current/`
5970
- Simply locate the file you want to translate in your target language folder (e.g., `/i18n/[language-code]/docusaurus-plugin-content-docs/current/`)
6071
- Translate the English content into your target language while preserving all markup, links, and formatting
6172
- You can also improve and complete partially translated pages
@@ -65,11 +76,11 @@ i18n/[language-code]/
6576
- Make sure formatting and links work correctly
6677
- You can test your translations locally by running:
6778
```bash
68-
yarn start -- --locale [language-code]
79+
yarn start --locale [language-code]
6980
```
7081
- For example, to test Spanish translations:
7182
```bash
72-
yarn start -- --locale es
83+
yarn start --locale es
7384
```
7485

7586
## Translation Guidelines

0 commit comments

Comments
 (0)