Contributing

Contributions of all kinds are welcome: documentation fixes, issue reports, feature suggestions, and code changes.

Report Issues

Search existing GitHub Issues first, then open a new one with:

• Steps to reproduce and expected behavior
• Screenshots or error logs
• Links to the relevant pages

Contribute Documentation

1. Fork this repository and create a branch, e.g. docs/update-getting-started
2. Edit the relevant page under content/
3. Run hugo server -D locally to check the result
4. Open a pull request describing the purpose of the change

Keep Translations in Sync

Simplified Chinese is the default language; English content uses the .en.md suffix:

content/docs/getting-started.md      # Simplified Chinese (default)
content/docs/getting-started.en.md   # English

Please update both languages when possible. If translation is not feasible yet, note it in the pull request.

Submit Changes

• Use clear English commit messages, e.g. docs: update getting started guide
• Keep each pull request focused on a single topic
• Do not commit build output such as public/ (already in .gitignore)
• Run a full build before submitting:

hugo --gc --minify

Content Guidelines

• Write in Markdown and use Hextra shortcodes (e.g. cards, callout) when helpful
• Keep titles concise and use weight to control sidebar order
• Cite sources when referencing external material
• Respect others’ work and follow the repository’s open-source license