Skip to content

60 implement visual architectural documentation diagrams as code - #61

Open
MathieuMRodrigue wants to merge 13 commits into
ros2from
60-implement-visual-architectural-documentation-diagrams-as-code
Open

MathieuMRodrigue wants to merge 13 commits into
ros2from
60-implement-visual-architectural-documentation-diagrams-as-code

Conversation

@MathieuMRodrigue

@MathieuMRodrigue MathieuMRodrigue commented May 22, 2026 •

Copy link
Copy Markdown
Collaborator

Première itération pour les diagrammes demandées par Louis. Considérant que j'ai jamais vraiment fait l'APP, c'était un peu difficile de faire certains liens, donc je vais avoir besoin de vos connaissances pour améliorer tout ça.

Aussi, je me suis concentrer sur ce qui est demandé dans l'issue, si vous voulez d'autres ajouts de documentation, vous pouvez les ajouter ici.

Merci !

Added a component map diagram to illustrate system architecture.
Updated system context and component map diagrams to reflect new architecture.
Updated the command flow sequence diagram to include a more complex core logic flow during autonomous operation.
@MathieuMRodrigue MathieuMRodrigue self-assigned this May 22, 2026
@MathieuMRodrigue MathieuMRodrigue added the documentation Improvements or additions to documentation label May 22, 2026
@MathieuMRodrigue MathieuMRodrigue linked an issue May 22, 2026 that may be closed by this pull request
5 tasks
@lopetit

lopetit commented May 24, 2026

Copy link
Copy Markdown
Collaborator

Merci Mathieu, c'est un bon début! Je pense que ce qu'il manquerait est le lien avec le code du github. Actuellement, ça aide à comprendre à haut niveau, mais ça n'aide pas encore à naviguer entre les différents folders et scripts.
Ça prendrait un diagramme avec une boite pour chaque folder(racecar_navigation, racecar_teleop, racecar_behaviours, etc) ou package, une courte description en une ligne de ce que ça fait, des sous-boites à l'intérieur avec les noeuds/scripts et description au besoin, et des branches pour montrer les liens entre les différentes sous-boites/boites. L'idée est que ça devienne la référence pour que les étudiants comprennent où aller voir "pourquoi ça fait ça" et "comment changer ça"

Comme piste de démarrage, voici (pour l'APP5, je suis moins au courant pour le reste) une liste non exhaustive (mais presque) des scripts pertinents:
labo_brushfire.py
path_following.py
cmd_vel_arbitration.py
arduino_sensors.py
blob_detector.py
libbehaviors.py
blob_detection.launch.py
behaviors.launch.py
simulation.launch.py
slam.launch.py
rviz.launch.py
navigation.launch.py
GRO830.launch.py
dual_ekf_params.yaml

dossiers:
racecar_gazebo
racecar_navigation
racecar_behaviors
racecar_bringup
racecar_behaviors/racecar_behaviors/
racecar_navigation/resource/
racecar_bringup/racecar_bringup/

fichiers:
validation.db
map.bmp
brushfire.bmp

J'ajoute le guide étudiant si tu veux faire un ctrl-f des noms ci-dessus pour aider à comprendre les liens si nécessaire: gro830-unite5-guide-etudiant_2026.pdf

Added a section detailing the Racecar nodes and their information flow.
Added new sections for 'Packages Overview' and 'Nodes Overview' in README
@MathieuMRodrigue

Copy link
Copy Markdown
Collaborator Author

@lopetit 2ième itération, j'ai ajouté 2 nouveaux diagrammes qui, je crois, répond à tes demandes

@lopetit

lopetit commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Ça a l'air vraiment bon! Tu pourrais le linker plus haut dans la structure, genre l'afficher (ou au minimum mettre un lien) dans le readme général

@MathieuMRodrigue

Copy link
Copy Markdown
Collaborator Author

J'ai ajouté un lien sur la page principale dans la section Documentation du readme général !

@lopetit

lopetit commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

Je pense que ça peut encore être mis plus en avant. C'est un bon outil pour comprendre le git, donc soit mettre plus d'emphase dessus (plutôt que un lien parmis beaucoup d'items dans une liste), ou même intégrer directement les figures dans le readme principal dans une section en bas de page. Merci!

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Implement Visual Architectural Documentation (Diagrams-as-Code)

2 participants