DevOps Dojo: ROS Node Documentation (Phase 1)

[kaspermeck-arm]

Checklist

• I've read the contribution guidelines.
• I've searched other issues and no duplicate issues were found.
• I've agreed with the maintainers that I can plan this task.

Description

DevOps: Ros Node Documentation will address the topic of how ROS nodes are documented. A consistent framework for how ROS nodes should be documented will be created and which will be rendered into accessible user-friendly documentation.

Phase 1 - Motivation

• [Todo: Add link]

Phase 2 - Definition

• [Todo: Add link]

Phase 3 - Execution

• [Todo: Add link]

Phase 4 - Integration

• [Todo: Add link]

Purpose

Phase 1 - Motivation:

• clear purpose
  • create structured way how to document nodes
• outline proposed work item
  • design/configuration/etc files compile into web UI documentation
• identify beneficiaries, stakeholders and shareholders

Possible approaches

TBD

Definition of done

Phase 1 is considered complete once satisfactory motivation has been outlined.

[stale]

This pull request has been automatically marked as stale because it has not had recent activity.