diff options
| author |   Natsuu <natsukawa247@outlook.com> | 2026-02-09 17:09:56 +0800 |
|---|---|---|
| committer |   GitHub <noreply@github.com> | 2026-02-09 17:09:56 +0800 |
| commit | 5bb2c660b90a4ae49282010031fb6245417b8396 (patch) | |
| tree | 27c6fa57d1b66141b43bbc0155b4e325ae9d37f1 /packages/docs | |
| parent | f656803e7419dc0ccbfdf86752e3284472fed164 (diff) | |
| download | DropOut-5bb2c660b90a4ae49282010031fb6245417b8396.tar.gz DropOut-5bb2c660b90a4ae49282010031fb6245417b8396.zip | |
docs: update language links and improve formatting in README files (#88)
## Summary by Sourcery
Improve bilingual README structure and formatting for clarity and
consistency.
Documentation:
- Add cross-links between English and Chinese READMEs for easier
language switching.
- Normalize README formatting including roadmap link styling, spacing,
and license section presentation in both languages.
Diffstat (limited to 'packages/docs')
| -rw-r--r-- | packages/docs/README.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/packages/docs/README.md b/packages/docs/README.md index 63b9290..f4e7563 100644 --- a/packages/docs/README.md +++ b/packages/docs/README.md @@ -5,6 +5,7 @@ This is the official documentation site for DropOut Minecraft Launcher, built wi ## Overview The documentation covers: + - **Getting Started**: Installation and first-time setup - **Features**: Detailed guides for all launcher features - **Architecture**: Technical design and implementation details @@ -14,6 +15,7 @@ The documentation covers: ### Multi-language Support The documentation is available in: + - **English** (default) - `content/docs/en/` - **简体中文** (Simplified Chinese) - `content/docs/zh/` @@ -68,7 +70,7 @@ pnpm format ## Project Structure -``` +```bash packages/docs/ ├── content/ │ └── docs/ # Documentation content (MDX) @@ -97,6 +99,7 @@ packages/docs/ ### Structure Documentation is organized by locale: + - English: `content/docs/en/` - Chinese: `content/docs/zh/` @@ -105,6 +108,7 @@ Each locale has the same structure with translated content. ### Configuration i18n is configured in: + - `source.config.ts`: Enables i18n support - `app/lib/source.ts`: Defines available languages and default @@ -160,6 +164,7 @@ Fumadocs provides several components: ### Translation Guidelines When translating content: + - Keep all code blocks in English - Translate frontmatter (title, description) - Keep technical terms (Tauri, Rust, Svelte, etc.) in English |