diff --git a/doc/assets/research_assets/node_path_ros.png b/doc/assets/research_assets/node_path_ros.png new file mode 100644 index 00000000..04def851 Binary files /dev/null and b/doc/assets/research_assets/node_path_ros.png differ diff --git a/doc/research/paf24/system/architecture_documentation.md b/doc/research/paf24/system/architecture_documentation.md index 5f9f2788..3164cf77 100644 --- a/doc/research/paf24/system/architecture_documentation.md +++ b/doc/research/paf24/system/architecture_documentation.md @@ -1,16 +1,20 @@ # Research about the existing architecture documentation -The repository holds various documents about how the architecture was planned and how the architecture should look or is +The repository already holds various documents about how the architecture was planned and how the architecture should look or is looking. As it is a crucial part of the project to understand the component interactions, especially the up-to-date version of it, in this document I will give a brief overview of the existing documentation and some links to the up-to-date versions. ## Existing architecture documentation from the previous semester +The main architecture documentation can be found [here](/ddoc/general/architecture.md). +It contains information to most nodes and what they subscribe / publish. + A miro board with the existing architecture (Perception, planning, acting) is existing. ![Architecture overview](/doc/assets/overview.jpg) The miro-board can be found [here](https://miro.com/welcomeonboard/a1F0d1dya2FneWNtbVk4cTBDU1NiN3RiZUIxdGhHNzJBdk5aS3N4VmdBM0R5c2Z1VXZIUUN4SkkwNHpuWlk2ZXwzNDU4NzY0NTMwNjYwNzAyODIzfDI=?share_link_id=785020837509). -This miro board does contain the main architecture details and flows of information but when comparing it to the rosgraph of the nodes and topics it seems like the diagram is not complete. +This miro board does contain the main architecture details and flows of information but when comparing it to the +rosgraph of the nodes and topics it seems like the diagram is not complete. -### Rosgraph of the nodes and topics of the project: +### Current Rosgraph of the nodes and topics of the project: [//]: # "![Up to date ros graph](/doc/assets/research_assets/rosgraph.svg)" ![Up to date ros graph](/doc/assets/research_assets/rosgraph_leaf_topics.svg) @@ -21,7 +25,8 @@ There you can see the nodes and the in- and outputs. In represents the subscribe This should now be extended by what logic is happening in which node and how the nodes are connected. ## Perception architecture - - TODO + - Extended information of how the perception works can be found [here](/doc/perception/README.md) ## Planning architecture - + - Extended information of how the planning works can be found [here](/doc/planning/README.md) ## Acting architecture + - Extended information of how the acting works can be found [here](/doc/acting/architecture_documentation.md)