Skip to content

docs: add bilingual beginner's guide and full i18n site - #199

Open
flyzstu wants to merge 1 commit into
spongebob888:mainfrom
flyzstu:docs-i18n-pr
Open

docs: add bilingual beginner's guide and full i18n site#199
flyzstu wants to merge 1 commit into
spongebob888:mainfrom
flyzstu:docs-i18n-pr

Conversation

@flyzstu

@flyzstu flyzstu commented Aug 9, 2026

Copy link
Copy Markdown

Summary

Adds a beginner-friendly bilingual (Chinese + English) guide and migrates the
docs site to Zensical's standard i18n mechanism.

Beginner's guide (Chinese + English)

  • What is ShadowQUIC
  • 5-minute quick start
  • Plain-word configuration walkthrough
  • FAQ

Full bilingual site

  • Two complete doc trees (docs/en, docs/zh) generated by gen_docs.py
    via a new --lang flag, each with its own zensical.toml config and a
    header language selector (extra.alternate) with hreflang tags.
  • The Chinese configuration reference is generated from the same rustdoc
    JSON with an exact-match translation table; untranslated entries fall
    back to English so the build never breaks.
  • Chinese API reference at document/api.zh.md.
  • CI builds both sites and merges them: / serves English, /zh/ serves
    Chinese.

Note

The guide is also cross-checked against the implementation (JLS
camouflage mechanism, admin API commands, config defaults, feature gating).

  • I have read the Contributor Guide
  • I have run the docs site build locally (gen_docs.py + zensical build)

- Beginner's guide (Chinese + English): what is ShadowQUIC, 5-minute
  quick start, plain-word config walkthrough, FAQ.
- Full bilingual site using Zensical's standard i18n mechanism: two
  complete doc trees (docs/en, docs/zh) rendered via gen_docs.py --lang,
  each with its own zensical config and a header language selector
  (extra.alternate) with hreflang tags.
- Chinese configuration reference generated from the same rustdoc JSON
  with an exact-match translation table; untranslated entries fall back
  to English.
- Chinese API reference (document/api.zh.md).
- Workflow builds both sites and merges them: / serves English,
  /zh/ serves Chinese.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant