Skip to content
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
29 changes: 20 additions & 9 deletions i18n/TRANSLATION_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,20 @@ Each language folder follows the same structure:
i18n/[language-code]/
├── docusaurus-plugin-content-docs/
│ └── current/
│ ├── intro.mdx
│ ├── faq.mdx
│ ├── release-notes.mdx
│ ├── advanced/
│ ├── installation/
│ └── troubleshooting/
│ │ ├── intro.mdx
│ │ ├── faq.mdx
│ │ ├── release-notes.mdx
│ │ ├── advanced/
│ │ ├── contributing/
│ │ ├── installation/
│ │ └── troubleshooting/
| └── current.json
├── docusaurus-plugin-content-blog/
└── docusaurus-theme-classic/
| └── options.json
├── docusaurus-theme-classic/
| ├── footer.json
| └── navbar.json
└── code.json
```

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

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

## Translation Guidelines
Expand Down