From 6db4a3b1807d0d305538a6b83ba9cad047f542d0 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 21 Jan 2026 13:01:23 +0000 Subject: docs: add comprehensive documentation for DropOut launcher Co-authored-by: HsiangNianian <44714368+HsiangNianian@users.noreply.github.com> --- packages/docs/README.md | 159 +++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 151 insertions(+), 8 deletions(-) (limited to 'packages/docs/README.md') diff --git a/packages/docs/README.md b/packages/docs/README.md index 2b4c09a..055e479 100644 --- a/packages/docs/README.md +++ b/packages/docs/README.md @@ -1,14 +1,157 @@ -# docs +# DropOut Documentation -This is a React Router application generated with -[Create Fumadocs](https://github.com/fuma-nama/fumadocs). +This is the official documentation site for DropOut Minecraft Launcher, built with [Fumadocs](https://fumadocs.dev) and React Router v7. -Run development server: +## Overview + +The documentation covers: +- **Getting Started**: Installation and first-time setup +- **Features**: Detailed guides for all launcher features +- **Architecture**: Technical design and implementation details +- **Development**: Building and contributing to DropOut +- **Troubleshooting**: Common issues and solutions + +## Development + +### Prerequisites + +- Node.js 22+ +- pnpm 9+ + +### Setup + +Install dependencies: + +```bash +pnpm install +``` + +### Run Development Server ```bash -npm run dev -# or pnpm dev -# or -yarn dev ``` + +This starts the development server at `http://localhost:5173` with hot reload enabled. + +### Build for Production + +```bash +pnpm build +``` + +The production build will be output to the `build/` directory. + +### Type Checking + +```bash +pnpm types:check +``` + +### Linting and Formatting + +```bash +# Check code +pnpm lint + +# Format code +pnpm format +``` + +## Project Structure + +``` +packages/docs/ +├── content/ +│ └── docs/ # Documentation content (MDX) +│ ├── index.mdx # Home page +│ ├── getting-started.mdx +│ ├── architecture.mdx +│ ├── development.mdx +│ ├── troubleshooting.mdx +│ └── features/ # Feature-specific docs +├── app/ # React Router app +├── public/ # Static assets +├── source.config.ts # Fumadocs configuration +└── react-router.config.ts # React Router configuration +``` + +## Writing Documentation + +### MDX Format + +All documentation is written in MDX (Markdown with JSX): + +```mdx +--- +title: Page Title +description: Page description for SEO +--- + +# Page Title + +Content goes here... + + + + +``` + +### Available Components + +Fumadocs provides several components: + +- `` - Link cards +- `` - Card container +- `` - Info/warning boxes +- `` - Tabbed content +- `` - Numbered steps +- Code blocks with syntax highlighting + +### Adding New Pages + +1. Create new `.mdx` file in `content/docs/` +2. Add frontmatter with title and description +3. Write content using MDX +4. Update `meta.json` to include the page +5. Test locally with `pnpm dev` + +### Organizing Content + +Use `meta.json` files to organize navigation: + +```json +{ + "title": "Section Title", + "pages": [ + "page1", + "page2", + { + "title": "Subsection", + "pages": ["sub1", "sub2"] + } + ] +} +``` + +## Deployment + +The documentation is automatically deployed when changes are merged to the main branch. + +## Contributing + +1. Fork the repository +2. Create a feature branch +3. Make your changes +4. Test locally +5. Submit a pull request + +## Links + +- [DropOut Repository](https://github.com/HydroRoll-Team/DropOut) +- [Fumadocs](https://fumadocs.dev) +- [React Router](https://reactrouter.com) + +## License + +MIT License - see the main repository for details. -- cgit v1.2.3-70-g09d2 From fe0cb04b26a543d6107f93b1fe3ca751c4d43148 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 21 Jan 2026 13:26:25 +0000 Subject: docs: configure i18n support and update documentation README Co-authored-by: HsiangNianian <44714368+HsiangNianian@users.noreply.github.com> --- packages/docs/README.md | 71 ++++++++++++++++++++---- packages/docs/content/docs/zh/features/meta.json | 2 +- packages/docs/content/docs/zh/meta.json | 4 +- 3 files changed, 64 insertions(+), 13 deletions(-) (limited to 'packages/docs/README.md') diff --git a/packages/docs/README.md b/packages/docs/README.md index 055e479..63b9290 100644 --- a/packages/docs/README.md +++ b/packages/docs/README.md @@ -11,6 +11,12 @@ The documentation covers: - **Development**: Building and contributing to DropOut - **Troubleshooting**: Common issues and solutions +### Multi-language Support + +The documentation is available in: +- **English** (default) - `content/docs/en/` +- **简体中文** (Simplified Chinese) - `content/docs/zh/` + ## Development ### Prerequisites @@ -34,6 +40,8 @@ pnpm dev This starts the development server at `http://localhost:5173` with hot reload enabled. +The documentation automatically supports language switching between English and Chinese. + ### Build for Production ```bash @@ -64,18 +72,50 @@ pnpm format packages/docs/ ├── content/ │ └── docs/ # Documentation content (MDX) -│ ├── index.mdx # Home page -│ ├── getting-started.mdx -│ ├── architecture.mdx -│ ├── development.mdx -│ ├── troubleshooting.mdx -│ └── features/ # Feature-specific docs +│ ├── en/ # English documentation +│ │ ├── index.mdx +│ │ ├── getting-started.mdx +│ │ ├── architecture.mdx +│ │ ├── development.mdx +│ │ ├── troubleshooting.mdx +│ │ └── features/ +│ └── zh/ # Chinese documentation +│ ├── index.mdx +│ ├── getting-started.mdx +│ ├── architecture.mdx +│ ├── development.mdx +│ ├── troubleshooting.mdx +│ └── features/ ├── app/ # React Router app ├── public/ # Static assets -├── source.config.ts # Fumadocs configuration +├── source.config.ts # Fumadocs configuration (i18n enabled) └── react-router.config.ts # React Router configuration ``` +## Internationalization (i18n) + +### Structure + +Documentation is organized by locale: +- English: `content/docs/en/` +- Chinese: `content/docs/zh/` + +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 + +### Adding a New Language + +1. Create a new directory: `content/docs/{locale}/` +2. Copy the structure from `en/` or `zh/` +3. Translate all `.mdx` files +4. Update `meta.json` files with translated titles +5. Add the language to `app/lib/source.ts` + ## Writing Documentation ### MDX Format @@ -110,11 +150,22 @@ Fumadocs provides several components: ### Adding New Pages -1. Create new `.mdx` file in `content/docs/` +1. Create new `.mdx` file in `content/docs/{locale}/` 2. Add frontmatter with title and description 3. Write content using MDX 4. Update `meta.json` to include the page -5. Test locally with `pnpm dev` +5. Repeat for all supported languages +6. Test locally with `pnpm dev` + +### Translation Guidelines + +When translating content: +- Keep all code blocks in English +- Translate frontmatter (title, description) +- Keep technical terms (Tauri, Rust, Svelte, etc.) in English +- Translate UI elements and descriptions +- Keep all links and URLs unchanged +- Maintain the same structure and formatting ### Organizing Content @@ -142,7 +193,7 @@ The documentation is automatically deployed when changes are merged to the main 1. Fork the repository 2. Create a feature branch -3. Make your changes +3. Make your changes (in all supported languages) 4. Test locally 5. Submit a pull request diff --git a/packages/docs/content/docs/zh/features/meta.json b/packages/docs/content/docs/zh/features/meta.json index 4725321..2fb2ded 100644 --- a/packages/docs/content/docs/zh/features/meta.json +++ b/packages/docs/content/docs/zh/features/meta.json @@ -1,5 +1,5 @@ { - "title": "Features", + "title": "功能特性", "pages": [ "index", "authentication", diff --git a/packages/docs/content/docs/zh/meta.json b/packages/docs/content/docs/zh/meta.json index 8ad7ea2..527801e 100644 --- a/packages/docs/content/docs/zh/meta.json +++ b/packages/docs/content/docs/zh/meta.json @@ -1,11 +1,11 @@ { - "title": "Documentation", + "title": "文档", "pages": [ "index", "getting-started", "architecture", { - "title": "Features", + "title": "功能特性", "pages": [ "features/index", "features/authentication", -- cgit v1.2.3-70-g09d2