Skip to content

Commit e24241d

Browse files
authored
create translation guide (#69)
1 parent 35b1d55 commit e24241d

File tree

1 file changed

+100
-0
lines changed

1 file changed

+100
-0
lines changed

i18n/TRANSLATION_GUIDE.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# SideStore Translation Guide
2+
3+
## Introduction
4+
5+
Thank you for your interest in helping translate SideStore's documentation! This guide will walk you through the process of contributing translations to make SideStore accessible to more users around the world.
6+
7+
## Project Structure
8+
9+
The translations are organized in the `i18n` directory with separate folders for each language:
10+
11+
- `de/` - German
12+
- `es/` - Spanish
13+
- `fr/` - French
14+
- `ja/` - Japanese
15+
- `ko/` - Korean
16+
- `nl/` - Dutch
17+
- `ru/` - Russian
18+
- `zh/` - Chinese
19+
20+
Each language folder follows the same structure:
21+
```
22+
i18n/[language-code]/
23+
├── docusaurus-plugin-content-docs/
24+
│ └── current/
25+
│ ├── intro.mdx
26+
│ ├── faq.mdx
27+
│ ├── release-notes.mdx
28+
│ ├── advanced/
29+
│ ├── installation/
30+
│ └── troubleshooting/
31+
├── docusaurus-plugin-content-blog/
32+
└── docusaurus-theme-classic/
33+
```
34+
35+
## Getting Started
36+
37+
### Prerequisites
38+
39+
- Basic knowledge of Markdown
40+
- Familiarity with the language you want to translate to
41+
- Git knowledge (for submitting changes)
42+
43+
### How to Contribute Translations
44+
45+
1. **Understand the translation system**
46+
- SideStore docs use Docusaurus for localization
47+
- Each language has its own folder with translated content
48+
- Content files follow the same structure as the original English docs
49+
50+
2. **Choose what to translate**
51+
- Start with untranslated or partially translated pages
52+
- Focus on most important pages first (intro, installation, FAQ)
53+
- Check existing translations for consistency
54+
55+
3. **Translation workflow**
56+
- The English files are already present in each language folder and ready for translation
57+
- Simply locate the file you want to translate in your target language folder (e.g., `/i18n/[language-code]/docusaurus-plugin-content-docs/current/`)
58+
- Translate the English content into your target language while preserving all markup, links, and formatting
59+
- You can also improve and complete partially translated pages
60+
61+
4. **Test your changes**
62+
- Run the site locally with your language to check how translations look
63+
- Make sure formatting and links work correctly
64+
- You can test your translations locally by running:
65+
```bash
66+
yarn start -- --locale [language-code]
67+
```
68+
- For example, to test Spanish translations:
69+
```bash
70+
yarn start -- --locale es
71+
```
72+
73+
## Translation Guidelines
74+
75+
### Do's
76+
77+
- Maintain consistent terminology throughout the documentation
78+
- Preserve all links and formatting from the original document
79+
- Use natural language appropriate for technical documentation
80+
- Keep the same file structure and naming
81+
82+
### Don'ts
83+
84+
- Don't translate code snippets
85+
- Don't change image paths or URLs
86+
- Don't modify the sidebar position or document metadata
87+
- Don't add or remove content beyond what's in the original documents
88+
89+
## Submitting Your Translations
90+
91+
Once you've completed translating a document:
92+
93+
1. Create a new branch for your changes
94+
2. Commit your changes with a descriptive message
95+
3. Submit a pull request to the main repository
96+
4. Wait for review and approval
97+
98+
## Need Help?
99+
100+
If you have any questions about the translation process or need clarification on technical terms, ping us in our discord server and we'll help you out as soon as possible.

0 commit comments

Comments
 (0)