-
Notifications
You must be signed in to change notification settings - Fork 144
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
docs: refactoring integration pages #493
base: main
Are you sure you want to change the base?
docs: refactoring integration pages #493
Conversation
Signed-off-by: ismetatabay <[email protected]>
Signed-off-by: ismetatabay <[email protected]>
This pull request has been automatically marked as stale because it has not had recent activity. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Making integration tutorial easily accessible through the top bar is a very nice addition. However, the overview page does not contains any overview that is currently present, and it would be nice to put it back while keeping the Overview page organized as it is in this PR
@@ -0,0 +1,39 @@ | |||
# Overview |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Previous page had a bit more information on the context of the integration. While this pr seem to organize the integration tutorial, it also makes it less transparent on the roles of each step. As a solution, I would propose to add more information at each of the section. Maybe adding an objection subsection to each of the sections would be nice before providing the link. For example, for the vehicle_inteface
section it could be: "To integrate Autoware into a real vehicle, it is necessary to connect the vehicle base controller with the Autoware control module. In a nutshell, in this section we develop a ROS2 package called vehicle_interface
that serves two purposes: 1. Receiving Autoware velocity commands through ROS2 topics, converting them into the vehicle specific commands and propagating them to the vehicle through thevehicle specific API. 2. Receiving the vehicle state through the vehicle specific API and propagating it to Autoware through ROS2 topics."
This pull request has been automatically marked as stale because it has not had recent activity. |
Description
Pre-review checklist for the PR author
The PR author must check the checkboxes below when creating the PR.
In-review checklist for the PR reviewers
The Reviewers must check the checkboxes below before approval.
Post-review checklist for the PR author
The PR author must check the checkboxes below before merging.
After all checkboxes are checked, anyone who has write access can merge the PR.