360 document and review systems architecture of autonomous driving platform #408
Conversation
…-of-autonomous-driving-platform
|
Warning Rate limit exceeded@SirMDA has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 8 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe changes in the Changes
Assessment against linked issues
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (3)
doc/research/paf24/system/architecture_documentation.md (3)
1-5: Enhance the introduction's clarity and professionalism.Consider restructuring the introduction to be more concise and professional:
-# Research about the existing architecture documentation -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. +# Architecture Documentation Overview + +This document provides a comprehensive overview of the autonomous driving platform's architecture documentation. It consolidates +existing architectural documentation, component interactions, and provides references to the most current documentation versions.🧰 Tools
🪛 Markdownlint
1-1: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
18-19: Remove commented out image reference.Remove the commented out graph reference since an active reference is already present.
-[//]: # ""
27-32: Enhance component architecture sections.The current sections lack context about each component's role in the system. Consider:
- Adding brief descriptions of each component's responsibilities
- Including key interfaces and dependencies
- Fixing the markdown formatting issues with proper list indentation and spacing
## Perception architecture + +The perception component processes sensor data to understand the vehicle's environment. + - Extended information of how the perception works can be found [here](/doc/perception/README.md) + ## Planning architecture + +The planning component determines the vehicle's path and behavior based on perception data. + - Extended information of how the planning works can be found [here](/doc/planning/README.md) + ## Acting architecture + +The acting component translates planning decisions into vehicle control commands. + - Extended information of how the acting works can be found [here](/doc/acting/architecture_documentation.md)🧰 Tools
🪛 Markdownlint
28-28: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
30-30: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
32-32: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
27-27: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
29-29: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
29-29: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
31-31: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
31-31: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
28-28: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
28-28: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
30-30: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
30-30: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
32-32: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (3)
doc/assets/research_assets/node_path_ros.pngis excluded by!**/*.pngdoc/assets/research_assets/rosgraph.svgis excluded by!**/*.svgdoc/assets/research_assets/rosgraph_leaf_topics.svgis excluded by!**/*.svg
📒 Files selected for processing (1)
doc/research/paf24/system/architecture_documentation.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
doc/research/paf24/system/architecture_documentation.md
[uncategorized] ~8-~8: The preposition “about” seems more likely in this position.
Context: ...chitecture.md). It contains information to most nodes and what they subscribe / pu...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~14-~14: Possible missing comma found.
Context: ...tecture details and flows of information but when comparing it to the rosgraph of t...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~15-~15: Consider using “incomplete” to avoid wordiness.
Context: ...and topics it seems like the diagram is not complete. ### Current Rosgraph of the nodes and...
(NOT_ABLE_PREMIUM)
🪛 Markdownlint
doc/research/paf24/system/architecture_documentation.md
28-28: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
30-30: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
32-32: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
14-14: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
1-1: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
6-6: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
21-21: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
27-27: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
29-29: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
29-29: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
31-31: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
31-31: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
17-17: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
21-21: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
28-28: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
28-28: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
30-30: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
30-30: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
32-32: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
🔇 Additional comments (1)
doc/research/paf24/system/architecture_documentation.md (1)
14-15: Specify the gaps between Miro board and actual implementation.
The document mentions that the Miro board diagram is incomplete compared to the ROS graph, but doesn't specify which aspects are missing. Consider adding details about:
- Which nodes or connections are missing
- What discrepancies exist between the documented and actual architecture
- Any planned updates to align the documentation
#!/bin/bash
# Verify if there's additional context about the architectural gaps in other documentation
rg -l "architecture.*gap" --type md🧰 Tools
🪛 LanguageTool
[uncategorized] ~14-~14: Possible missing comma found.
Context: ...tecture details and flows of information but when comparing it to the rosgraph of t...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~15-~15: Consider using “incomplete” to avoid wordiness.
Context: ...and topics it seems like the diagram is not complete. ### Current Rosgraph of the nodes and...
(NOT_ABLE_PREMIUM)
🪛 Markdownlint
14-14: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
Description
This adds an updated architecture documentation. It was checked which nodes exist and which connections are between them. Issues for checking the architecture of the subteams were created (#392 #393 #394 #395) These will be done the next sprint to extend the documentation further.
Fixes #360
Type of change
Please delete options that are not relevant.
Does this PR introduce a breaking change?
No
Most important changes
Added a new image which holds the information of the current rosgraphs nodes and connections between them.
Checklist:
Summary by CodeRabbit