Repository navigation
docs: enforce CONTRIBUTING conventions across en/zh pages - #189
Merged
Merged
Conversation
Bring the docs set into line with the "Documentation conventions" in
CONTRIBUTING.md. All bilingual heading count/order, table shape, and
See also parity preserved; `mkdocs build --strict` passes.
- Terminology: unify "flags" -> 标志 and "override path" rendering in
the CLI/reference pages (drop stray 参数 / flag / 可覆盖路径).
- See also: trim overview & play-train blocks to the <=3 cap (drop the
CLI Reference entry); remove the mid-body cross-page link in
play-train that duplicated the See also entry.
- Section headings: convert English imperative headings to gerund/noun
form (CLI, concepts, best-practices, examples, getting-started,
tutorial); add a stable { #run-commands } anchor so the quickstart
link survives the installation heading rename. Chinese verb-object
headings already match the convention and are left unchanged.
- Second person: drop you/your (en) and 你/您 (zh installation).
- Chatty openers: rewrite "This guide/page/..." / "本指南/本页/..."
first paragraphs to lead with substance.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
actuators.en was missing the `MujocoStyleActuatorCfg` intro line and the
entire "MJCF-style actuator configuration" section that actuators.zh
documents (with a same-page link to the `#mjcf-style-actuator-configuration`
anchor). Add the English equivalents — same code block, comments
translated, same explicit anchor — so the two pages match heading-for-heading
(now 7 each).
reference-runs.{en,zh} needed no change: the real heading structure already
matches (15 each); the earlier 24/23 count was code-block comments, not
section headings.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
KraHsu
added a commit
that referenced
this pull request
Jun 5, 2026
docs: enforce CONTRIBUTING conventions across en/zh pages
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
1 participant
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.
Brings the docs set into line with the Documentation conventions in
CONTRIBUTING.md. Pure documentation change — no source touched. Bilingual heading count/order, table shape, andSee alsoparity preserved;mkdocs build --strictpasses.What changed
标志and the "override path" rendering across the CLI/reference pages (drop stray参数/flag/可覆盖路径).See also≤ 3 — trimoverview&play-trainblocks to the cap (drop theCLI Referenceentry); remove the mid-body cross-page link inplay-trainthat duplicated theSee alsoentry (Rule 5).{ #run-commands }anchor so the quickstart link survives theinstallationheading rename. Chinese verb-object headings already match the convention and are left unchanged.you/your(en) and你/您(zh installation).This guide/page/…/本指南/本页/…first paragraphs to lead with substance.Verification
ruff check,ruff format --check,lint-imports— cleanpyright— 0 errorspytest— 655 passedmkdocs build --strict— passes (anchors/links resolve, incl. quickstart →#run-commands)Pre-existing en/zh heading-count gaps in
concepts/actuators(6/8) andbest-practices/reference-runs(24/23) are untouched by this PR and noted for separate follow-up.🤖 Generated with Claude Code