Skip to content

Docs-site specifications

This section explains how docs-site/ is organized. It does not define training behavior.

What lives here

  • MkDocs PRD: structure, bilingual rules, navigation rules, and writing boundaries
  • GitHub Actions PRD: build and deploy rules for GitHub Pages
  • Markdown Tree: the file map that shows direct-write files and symlink source-to-target pairs

Why these files matter

The docs site is a small project of its own. Without explicit structure documents, two problems appear quickly:

  1. new pages are added without a clear rule for direct-write versus symlink reuse
  2. Chinese and English navigation drift apart

How to use this section

If you are extending the docs site:

  1. read the Markdown tree first
  2. check the MkDocs PRD for structure and DRY constraints
  3. check the GitHub Actions PRD if the change affects deployment boundaries