القائمة
Cross-checks RLinf documentation against code and other docs, including English-Chinese parity checks. Use when adding or editing docs, reviewing doc PRs, validating commands/config keys/model-env names, or ensuring EN and ZH docs stay consistent.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | docs-check |
| description | Cross-checks RLinf documentation against code and other docs, including English-Chinese parity checks. Use when adding or editing docs, reviewing doc PRs, validating commands/config keys/model-env names, or ensuring EN and ZH docs stay consistent. |
Use this skill when documentation changes may introduce mismatches with:
Always read reference.md first, then run the workflow below.
Collect these inputs before reviewing:
If scope is unclear, default to checking:
docs/source-en/ and docs/source-zh/ counterpartsrlinf/config.py (SupportedModel)rlinf/envs/__init__.py (SupportedEnvType)examples/, toolkits/, ray_utils/, and requirements/reference.md and extract the relevant checklist items.SupportedModel and SupportedEnvType string values.:doc:/relative links, not hardcoded ReadTheDocs URLs.Critical: Wrong command/path/key/value that can break user workflow.Major: Inconsistent docs that likely mislead users.Minor: Wording/terminology drift without immediate breakage.Prefer actionable findings with exact file paths and corrected values.
Hardcoded ReadTheDocs links to RLinf docs should be reported as at least Major.
Use this format when reporting results:
## Docs Check Findings
- Critical: <issue>, in `<path>`
- Why: <impact>
- Fix: <specific correction>
- Major: <issue>, in `<path>`
- Why: <impact>
- Fix: <specific correction>
- Minor: <issue>, in `<path>`
- Why: <impact>
- Fix: <specific correction>
## Verified
- <what was checked and confirmed>
If no issues are found, explicitly state:
No doc-code or EN-ZH consistency issues found in checked scope.
readthedocs.io/.../rst_source/... URLs; convert to :doc: or relative internal links.Use this regex scan to detect unstable hardcoded RLinf docs links:
readthedocs\.io/(en|zh-cn)/latest/rst_source/Adds example documentation for a new model or environment in RLinf (RST pages in the docs gallery for both English and Chinese). Use when adding a new embodied or reasoning example, or new benchmark (e.g. LIBERO, ManiSkill).
Adds install command in install script, Docker build stage in Dockerfile, and CI jobs for docker build, install script, and embodied e2e test when introducing a new model or environment in RLinf. Use when adding a new embodied model (e.g. dexbotic), new env (e.g. maniskill_libero), or new model+env combination that should be installable, dockerized, and tested in CI.
Adds a new publication page to the RLinf Sphinx docs (EN + ZH) and wires it into the Publications index/toctree and navbar. Use when the user asks to add a publication/paper page, convert a paper README/markdown into docs, or update the publications listing.
Reviews a pull request from a PR URL by directly fetching the URL content (no `gh` dependency) and verifies compliance with CONTRIBUTING.md. Use when the user asks for a PR review, to review changes before merge, or to check contribution guidelines.