ros2 / ros2/launch

Add basic doc skeleton for launch_xml/yaml frontends

Open
#929 1 comment 1 reaction 2 assignees View on GitHub

@lsy3 is already working on this.

Since Nov 26, 2025.

enhancement
Dominant language
Python
Stars
155
Forks
182
Avg merge
2d 14h
Merged PRs (30d)
6

Description

Description

Provide a place to start adding more structured documentation beyond just the README. Start with an doc/index.rst or whatever the basic tutorial recommends for getting started: https://docs.ros.org/en/rolling/How-To-Guides/Documenting-a-ROS-2-Package.html#configuration

Motivation

Working toward having a design and usage reference, and colocating it with the code makes a lot more sense than splitting into arbitrary tutorials/guides in ros2_documentation. This is the first step to building out that structure.

Design / Implementation Considerations

No response

Additional Information

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.