Skip to content

docs: add documentation for chart_lab world and dispatch_zone task - #373

Open
muskan-creates352 wants to merge 1 commit into
open-rmf:mainfrom
muskan-creates352:docs/chart-lab-and-dispatch-zone
Open

muskan-creates352 wants to merge 1 commit into
open-rmf:mainfrom
muskan-creates352:docs/chart-lab-and-dispatch-zone

Conversation

@muskan-creates352

@muskan-creates352 muskan-creates352 commented Nov 7, 2026 •

Copy link
Copy Markdown

Documentation Update

Linked Issue

Fixes #372

Description of changes

This PR documents the newly added chart_lab world and dispatch_zone CLI task from PR #350:

  1. README.md:
    • Added * [Chart Lab World](#Chart-Lab-World) under the Demo Worlds list.
    • Added a detailed ### Chart Lab World section with launch instructions (both Gazebo and mock visualization) and scenario launch commands (tinybots_to_zone.launch.xml, tinybots_go_to_consultation_points.launch.xml, flood_zone.launch.xml).
  2. rmf_demos_tasks/README.md:
    • Fixed package header typo (# rmf_demos_tasks).
    • Added dispatch_zone documentation with CLI arguments (-z, -H, -F, -R, etc.) and example usage.

Testing

  • Verified Markdown formatting and preview renders properly.

GenAI Use

We follow OSRA's policy on GenAI tools

  • I used a GenAI tool in this PR.
  • I did not use GenAI

Tool used: Google Antigravity

Document chart_lab demo world launch commands in main README.md and add dispatch_zone usage examples in rmf_demos_tasks/README.md.

Fixes open-rmf#372

Signed-off-by: Muskan Kumari <er.muskan09@gmail.com>
@mxgrey mxgrey added this to PMC Board Nov 7, 2026
@github-project-automation github-project-automation Bot moved this to Inbox in PMC Board Nov 7, 2026

@aaronchongth aaronchongth left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Before the team starts reviewing, please fill up the declaration of whether generative AI was used

@muskan-creates352

Copy link
Copy Markdown
Author

Updated the description with the GenAI declaration! @aaronchongth

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Inbox

Development

Successfully merging this pull request may close these issues.

[Docs]: Add documentation and launch instructions for chart_lab world and dispatch_zone task

2 participants