Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature]: automated documentation of current car architecture #552

Open
2 tasks
asamluka opened this issue Dec 9, 2024 · 0 comments
Open
2 tasks

[Feature]: automated documentation of current car architecture #552

asamluka opened this issue Dec 9, 2024 · 0 comments
Labels
system System Engineering

Comments

@asamluka
Copy link
Collaborator

asamluka commented Dec 9, 2024

Feature Description

The documentation gets outdated pretty fast. Keeping it up to date manually is a time consuming procedure. Automating this would save time in the long run and ensures, that reader of the documentation always see the newest build.

Definition of Done

  • simple script that gathers needed information
  • autogeneration of markdown file with current information about subscribers and publishers

Testability

Generate a markdown and compare to current code or rqt graph.

Dependencies

No response

@asamluka asamluka added the system System Engineering label Dec 9, 2024
@asamluka asamluka moved this to 📋 Backlog in PAF Project Backlog Dec 9, 2024
@asamluka asamluka changed the title [Feature]: automated documentation of current car architecuture [Feature]: automated documentation of current car architecture Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
system System Engineering
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant