60 implement visual architectural documentation diagrams as code - #61
MathieuMRodrigue wants to merge 13 commits into
Conversation
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.
|
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. 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: dossiers: fichiers: 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
|
@lopetit 2ième itération, j'ai ajouté 2 nouveaux diagrammes qui, je crois, répond à tes demandes |
|
Ç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 |
Add link in main page
|
J'ai ajouté un lien sur la page principale dans la section Documentation du readme général ! |
|
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! |
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 !