Skip to content

Possible to add How-to Guides section? #120

@cardboardcode

Description

@cardboardcode

This is an open-question to explore the possibility of including a new section called How-to Guides.

Currently, here are the existing sections in the ros2multirobotbook,

1. Introduction
2. ROS 2
3. Traffic Editor
4. Simulation
5. RMF Core Overview
6. Tasks in RMF
7. SOSS
8. Integration
9. RMF Web
10. Security
11. Roadmap

Why Add This? 🔍

There are a handful benefits I see in this proposed addition, as listed below:

  • Encourage community contribution to address specific topics which other sections cannot address by themselves.
  • Serve as a catch-all section for topics that don't fit into any existing sections.
  • Adheres to the same pattern as the official ROS 2 documentation.

Here is a reference to how How-to Guides are managed in the official ROS 2 Documentation.

Remarks 💬

Would like to hear your thoughts on this.

This could also help address issues such as #101 and #58.

Other specific topics may include:

  • How to develop a Ready-Only Fleet Adapter for your Robot.
  • How to develop a Traffic-Light Fleet Adapter for your Robot.
  • How to optimise your RMF-based docker images.
  • A step-by-step guide on writing your Robot's Fleet Adapter.
  • ecetera

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions