Repository navigation
docs: add complete English manual and automatic bilingual Wiki sync - #28
Merged
Merged
Conversation
Move the 48-page Chinese manual under docs/zh and provide matching English pages, navigation, README links, and Wiki language switching. Validate translation coverage, shared examples, and links in CI. Keep UNCERTAIN outcome documentation in its dependent feature PR.
Makiras
changed the title
Makiras
marked this pull request as ready for review
October 30, 2026 08:47
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The user manual is currently Chinese-only and Wiki updates require a separate manual push. Provide matching Chinese and English documentation, then automatically publish validated Wiki pages after documentation reaches
main.Move the existing 48-page manual to
docs/zh/and add all 48 English counterparts indocs/en/, following the same tutorials, how-to, reference, and explanation structure. Add an English README, language switching, translated navigation, and updated absolute README links. Keep executable examples identical between languages and validate both against the tutorial source. Correct two outdated expression-capability statements in the migration guide.The documentation workflow builds both languages and exports 99 Wiki pages: 96 content pages, a language-selection Home, sidebar, and footer. Each content page links to its counterpart and main-branch source. Checks reject missing translations, untranslated navigation, changed shared examples, and broken local links. Documentation dependencies are pinned consistently for local builds and CI.
Only validated
mainpush/manual runs synchronize the Wiki using the built-in GITHUB_TOKEN. PRs, including dependent PRs, produce previews only. Manifest-based sync verifies hashes, preserves unrelated pages, rejects unsafe paths/manual conflicts, serializes updates, skips superseded exports, and never force-pushes. Legacymasteris outside this flow.Validation:
02346ae.The Wiki now has its initial Home page. No additional token secret is needed; the live Wiki is not modified by this PR preview.
Dependency: #29 builds on this bilingual baseline and adds UNCERTAIN-specific Chinese and English guidance. Merge this PR first, then retarget #29 to
mainand revalidate it. Release classification isrelease:patch; the repository's merge policy can trigger a package release, so this PR remains draft and unmerged pending maintainer confirmation.