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).
Use this skill when adding example documentation for a new model (e.g. π₀, GR00T, OpenVLA) or environment (e.g. LIBERO, ManiSkill, MetaWorld) in RLinf. Documentation is added for both English and Chinese.
Create the English RST file
Examples are now grouped by category:
embodied/ – embodied RL/VLA examples (e.g. ManiSkill, LIBERO, Dexbotic, π₀, OpenSora)agentic/ – agent / tool-use / coder / math reasoning examples (e.g. SearchR1, coding_online_rl, reasoning)system/ – placement, scheduling, system demosdocs/source-en/rst_source/examples/<category>/<name>.rstdocs/source-en/rst_source/examples/embodied/dexbotic.rstdocs/source-en/rst_source/examples/agentic/searchr1.rst
Follow the structure of existing examples in the same category (see ).Register in the English category index
Each category has its own index file (e.g. docs/source-en/rst_source/examples/embodied/index.rst).
docs/source-en/rst_source/examples/<category>/index.rst.<name> in the hidden .. toctree:: at the bottom (e.g. dexbotic).examples/index.rst now only links to the four category indexes and usually does not need to be changed when adding a single example.If it is an embodied evaluation environment
In docs/source-en/rst_source/start/vla-eval.rst, add a line in the “List of currently supported evaluation environments”:
:doc:\Display Name <../examples/embodied/<name>``Create the Chinese RST file
Use the same <category> and <name> as in English:
Path: docs/source-zh/rst_source/examples/<category>/<name>.rst.
Mirror the English content (same structure and sections). Use existing EN/ZH pairs under the same category (e.g. embodied/libero.rst in both source-en and source-zh) as reference.
Register in the Chinese category index
Edit docs/source-zh/rst_source/examples/<category>/index.rst:
<name> entry to the hidden .. toctree::.../examples/embodied/<name> for embodied.Update README.md
In the "What's NEW!" section at the top, add a new dated bullet, with the documentation link pointing to the correct category path, e.g.:
- [YYYY/MM] 🔥 ... Doc: [Display Title](https://rlinf.readthedocs.io/en/latest/rst_source/examples/embodied/<name>.html).Update README.zh-CN.md
In the "最新动态" section, add the same news item in Chinese with the doc link using /zh-cn/ and the correct category path, for example:
https://rlinf.readthedocs.io/zh-cn/latest/rst_source/examples/embodied/<name>.htmlzh-cn in the link, and the same <category> segment).Use existing examples in the same category (e.g. embodied/libero.rst, embodied/pi0.rst, agentic/searchr1.rst) as templates; see reference.md for a minimal template.
docs/source-en/rst_source/examples/<category>/<name>.rst.docs/source-en/rst_source/examples/<category>/index.rst (toctree; optional gallery card).docs/source-en/rst_source/start/vla-eval.rst updated with ../examples/embodied/<name>.docs/source-zh/rst_source/examples/<category>/<name>.rst.docs/source-zh/rst_source/examples/<category>/index.rst (toctree; gallery card if added for EN).