Skip to content

Add docs for adding new robot#172

Merged
yuecideng merged 2 commits intomainfrom
yueci/add-robot-docs
Mar 11, 2026
Merged

Add docs for adding new robot#172
yuecideng merged 2 commits intomainfrom
yueci/add-robot-docs

Conversation

@yuecideng
Copy link
Contributor

Description

  • Added new tutorial docs/source/tutorial/add_robot.rst covering two
    approaches for robot definition:
    • Single-file approach (for simple robots like CobotMagic)
    • Package-based approach (for complex robots like DexforceW1)
  • Documented key configuration parameters: URDF configuration, control
    parts, drive properties, IK solver settings
  • Added section on creating robot documentation in
    docs/source/resources/robot/
  • Updated AGENTS.md with references to the new tutorial and robot docs
    requirement

Type of change

  • Documentation update

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.

@yuecideng yuecideng added the docs Improvements or additions to documentation label Mar 11, 2026
Copilot AI review requested due to automatic review settings March 11, 2026 06:02
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new “Adding a New Robot” tutorial to the Sphinx docs and links it from existing documentation so contributors have a clear guide for robot definitions and required robot docs pages.

Changes:

  • Added a new tutorial page add_robot.rst describing single-file and package-based robot definitions and key configuration knobs.
  • Linked the new tutorial from docs/source/tutorial/index.rst.
  • Updated AGENTS.md to point contributors to the new tutorial and robot documentation requirements.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.

File Description
docs/source/tutorial/index.rst Adds add_robot to the tutorials toctree so it appears in the docs navigation.
docs/source/tutorial/add_robot.rst New tutorial content covering robot implementation patterns and required documentation.
AGENTS.md Updates contributor guidance to reference the new tutorial and robot docs index requirements.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@yuecideng yuecideng merged commit eeeb0bc into main Mar 11, 2026
2 checks passed
@yuecideng yuecideng deleted the yueci/add-robot-docs branch March 11, 2026 15:15
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.

2 participants