Skip to content

docs: improve navigation, cross-references, and guides#262

Merged
yuecideng merged 1 commit into
mainfrom
docs/improve-docs-navigation-and-guides
May 12, 2026
Merged

docs: improve navigation, cross-references, and guides#262
yuecideng merged 1 commit into
mainfrom
docs/improve-docs-navigation-and-guides

Conversation

@yuecideng
Copy link
Copy Markdown
Contributor

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

  • Fix dangling sentence in modular_env.rst ("for more randomization events, please refer" → proper cross-reference)
  • Clean up resources/task/index.rst broken toctree entries
  • Add project overview paragraph to root index.rst
  • Add numbered 3-phase learning path with prerequisites to tutorial/index.rst

P1 — Navigation & Cross-references

  • Add "See Also" / "Next Steps" sections to: RL tutorial, agents, online data, create_scene, basic_env, RL overview, gym/env overview
  • Resolve add_robot duplication: replace guides/add_robot.rst with concise checklist + link to full tutorial

P2 — New Guide Content

  • Custom Functors Guide (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 conventions
  • Configuration Guide (guides/configuration.md): Explains @configclass, FunctorCfg hierarchy, JSON config format, string-based function resolution, and SceneEntityCfg usage
  • Fix guides/index.rst title underline and add new entries

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (non-breaking change which improves an existing functionality)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (existing functionality will not work without user modification)
  • Documentation update

Screenshots

N/A — documentation text changes only.

Checklist

  • I have run the black . command to format the code base.
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • Dependencies have been updated, if applicable.

🤖 Generated with Claude Code

- 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>
@yuecideng yuecideng added the docs Improvements or additions to documentation label May 12, 2026
@yuecideng yuecideng merged commit e11eb4e into main May 12, 2026
4 of 5 checks passed
@yuecideng yuecideng deleted the docs/improve-docs-navigation-and-guides branch May 12, 2026 04:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant