rlinf/docs-check
.cursor/skills/docs-check/SKILL.md
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.
$ install --global
skillsauthnpx skillsauth add rlinf/rlinf docs-checkInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 11, 2026, 10:55 PM7.2s2 files scanned
SKILL.md
- 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.
Docs Check
Quick Start
Use this skill when documentation changes may introduce mismatches with:
- Code and config source of truth
- Other existing docs in the same section
- English and corresponding Chinese docs
Always read reference.md first, then run the workflow below.
Inputs
Collect these inputs before reviewing:
- Changed doc files (or target docs to validate)
- Corresponding EN and ZH files for the same topic
- Related code/config files referenced by the docs
If scope is unclear, default to checking:
docs/source-en/anddocs/source-zh/counterpartsrlinf/config.py(SupportedModel)rlinf/envs/__init__.py(SupportedEnvType)- Referenced scripts under
examples/,toolkits/,ray_utils/, andrequirements/
Workflow
- Read
reference.mdand extract the relevant checklist items. - Verify doc-to-code correctness:
- Commands exist and are runnable in principle.
- Script/module paths in docs exist.
- Config keys and values match real code/config names.
- Model/env names match
SupportedModelandSupportedEnvTypestring values.
- Verify doc-to-doc consistency within one language:
- Terminology is consistent across start/tutorials/examples/API pages.
- New page is linked in the correct index/toctree.
- No conflicting instructions between related pages.
- Internal doc links use stable
:doc:/relative links, not hardcoded ReadTheDocs URLs.
- Verify EN-ZH parity:
- Same topic coverage and section structure.
- Same commands, config keys, and model/env identifiers.
- Translations preserve technical meaning (do not rename code symbols).
- Corresponding EN/ZH pages use equivalent stable internal links.
- Report findings with severity and concrete fixes.
Severity Rules
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.
Output Format
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.
Guardrails
- Do not invent model/env/config names; verify against source files.
- Do not change code to match incorrect docs unless explicitly requested.
- Keep EN and ZH technical tokens identical where applicable (paths, CLI flags, keys, enum values).
- When uncertain, flag as an assumption and request confirmation.
- Do not keep RLinf internal links as hardcoded
readthedocs.io/.../rst_source/...URLs; convert to:doc:or relative internal links.
Quick Detection
Use this regex scan to detect unstable hardcoded RLinf docs links:
readthedocs\.io/(en|zh-cn)/latest/rst_source/
Additional Resource
- Detailed checklist and paths: reference.md
Related Skills
rlinf/review-pr
testing
VerifiedTrustedCommunity
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.
3,059SKILL.mdUpdated Apr 11, 2026
rlinf/add-publication-docs
documentation
VerifiedTrustedCommunity
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.
3,059SKILL.mdUpdated Apr 11, 2026
rlinf/add-install-docker-ci-e2e
development
VerifiedTrustedCommunity
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.
3,059SKILL.mdUpdated Apr 11, 2026
rlinf/add-example-doc-model-env
documentation
VerifiedTrustedCommunity
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).
3,059SKILL.mdUpdated Apr 11, 2026