docs: improve navigation, cross-references, and guides#262
Merged
Conversation
- Add project overview paragraph to root index page - Add numbered learning path with prerequisites to tutorial index - Fix broken dangling sentence in modular_env tutorial - Clean up resources/task/index toctree - Resolve add_robot duplication: replace guide with checklist + link to tutorial - Add "See Also" / "Next Steps" sections across RL tutorial, agents, online data, create_scene, basic_env, RL overview, gym/env overview - Add custom functors guide (function-style and class-style patterns) - Add configuration guide (@configclass, FunctorCfg, JSON config) - Fix guides/index.rst title underline Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.
Description
This PR improves documentation navigation, fixes broken content, and adds new guides to make EmbodiChain docs easier to understand and follow.
P0 — Broken Content Fixed
modular_env.rst("for more randomization events, please refer" → proper cross-reference)resources/task/index.rstbroken toctree entriesindex.rsttutorial/index.rstP1 — Navigation & Cross-references
add_robotduplication: replaceguides/add_robot.rstwith concise checklist + link to full tutorialP2 — New Guide Content
guides/custom_functors.md): Covers function-style and class-style functor patterns with real code examples for observation, reward, event, and action functors, plus a signature reference table and file placement conventionsguides/configuration.md): Explains@configclass,FunctorCfghierarchy, JSON config format, string-based function resolution, andSceneEntityCfgusageguides/index.rsttitle underline and add new entriesType of change
Screenshots
N/A — documentation text changes only.
Checklist
black .command to format the code base.🤖 Generated with Claude Code