docs: fix styles #139
Merged
docs: fix styles #139
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Kenji Miyake <[email protected]>
4 tasks
maxime-clem
reviewed
Jun 6, 2022
| @@ -18,7 +18,7 @@ The Universe modules are extensions to the Core module that can be provided by t | |||
|
|
|||
| ## Interface design | |||
|
|
|||
| The interface design is the most essential piece of the microautonomy architecture, which is classified into internal and external interfaces. The component interface is designed for the components in a Universe module to communicate with those in other modules, including the Core module, within Autoware internally. The AD(Autonomous Driving) API, on the other hand, is designed for the applications of Autoware to access the technology components in the Core and Universe modules of Autoware externally. Designing solid interfaces, the microautonomy architecture is made possible with our partners, and at the same time is made feasible for our partners. | |||
| The interface design is the most essential piece of the microautonomy architecture, which is classified into internal and external interfaces. The component interface is designed for the components in a Universe module to communicate with those in other modules, including the Core module, within Autoware internally. The AD(Autonomous Driving) API, on the other hand, is designed for the applications of Autoware to access the technology components in the Core and Universe modules of Autoware externally. Designing solid interfaces, the microautonomy architecture is made possible with AWF's partners, and at the same time is made feasible for the partners. | |||
There was a problem hiding this comment.
This is unrelated to your changes but that last sentence is not clear to me.
There was a problem hiding this comment.
Yes, actually it was unclear to me as well. Do you have any ideas for alternative sentences?
There was a problem hiding this comment.
Or can I merge this if I create an issue to update this page?
There was a problem hiding this comment.
There was already an issue. #81
I've added a comment.
maxime-clem
approved these changes
Jun 6, 2022
Sharrrrk
pushed a commit
to Sharrrrk/autoware-documentation
that referenced
this pull request
Jun 7, 2022
Signed-off-by: Kenji Miyake <[email protected]> Signed-off-by: Shark Liu <[email protected]>
Sharrrrk
pushed a commit
to Sharrrrk/autoware-documentation
that referenced
this pull request
Jun 7, 2022
Signed-off-by: Kenji Miyake <[email protected]> Signed-off-by: Shark Liu <[email protected]>
Sharrrrk
pushed a commit
to Sharrrrk/autoware-documentation
that referenced
this pull request
Jun 7, 2022
Signed-off-by: Kenji Miyake <[email protected]> Signed-off-by: Shark Liu <[email protected]>
Sharrrrk
added a commit
that referenced
this pull request
Jun 7, 2022
* docs: update troubleshooting guide (#107) * docs: update troubleshooting guide Signed off by: Lalith Vipulananthan <[email protected]> * ci(pre-commit): autofix * Removed TOC and updated the setup section title * Update docs/support/troubleshooting.md Co-authored-by: Kenji Miyake <[email protected]> * Update docs/support/troubleshooting.md Co-authored-by: Kenji Miyake <[email protected]> * Update docs/support/troubleshooting.md Add swap configuration steps Co-authored-by: Kenji Miyake <[email protected]> * ci(pre-commit): autofix * fix code blocks Signed-off-by: Kenji Miyake <[email protected]> * Create troubleshooting.md Reworded the CUDA warning to specify the supported version, fixed the code block for the swap config steps and added the Digital Ocean link back in. * ci(pre-commit): autofix * Update docs/support/troubleshooting.md Co-authored-by: Kenji Miyake <[email protected]> * Update docs/support/troubleshooting.md Co-authored-by: Kenji Miyake <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Kenji Miyake <[email protected]> Signed-off-by: Shark Liu <[email protected]> * docs(installation): update installation pages (#104) * docs: rename developper settings Signed-off-by: Shumpei Wakabayashi <[email protected]> * ci(pre-commit): autofix Signed-off-by: Shumpei Wakabayashi <[email protected]> * fix: link Signed-off-by: Shumpei Wakabayashi <[email protected]> * fix Signed-off-by: Shumpei Wakabayashi <[email protected]> * docs(autoware-interfaces): add autoware interface design (#69) * docs(autoware-interfaces): add autoware interface design Signed-off-by: Takagi, Isamu <[email protected]> * docs(autoware-interfaces): remove version from api name Signed-off-by: Takagi, Isamu <[email protected]> * docs(autoware-interfaces): mention the local interface Signed-off-by: Takagi, Isamu <[email protected]> Signed-off-by: Shumpei Wakabayashi <[email protected]> * chore: fix name Signed-off-by: Shumpei Wakabayashi <[email protected]> * chore: fix name Signed-off-by: Shumpei Wakabayashi <[email protected]> * chore: fix name Signed-off-by: Shumpei Wakabayashi <[email protected]> * fix: url Signed-off-by: Shumpei Wakabayashi <[email protected]> * chore: fix name Signed-off-by: Shumpei Wakabayashi <[email protected]> * chore: fix name Signed-off-by: Shumpei Wakabayashi <[email protected]> * chore: fix name Signed-off-by: Shumpei Wakabayashi <[email protected]> * fix: rm duplication Signed-off-by: Shumpei Wakabayashi <[email protected]> * Update docs/installation/index.md Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Shumpei Wakabayashi <[email protected]> * Update docs/installation/index.md Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Shumpei Wakabayashi <[email protected]> * Update docs/installation/index.md Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Shumpei Wakabayashi <[email protected]> * chore: rm old ref Signed-off-by: Shumpei Wakabayashi <[email protected]> * Update docs/installation/index.md Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Shumpei Wakabayashi <[email protected]> * chore: edit name Signed-off-by: Shumpei Wakabayashi <[email protected]> * Update docs/installation/index.md Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Shumpei Wakabayashi <[email protected]> * chore: lead to support Signed-off-by: Shumpei Wakabayashi <[email protected]> * rm duplication Signed-off-by: Shumpei Wakabayashi <[email protected]> * ci(pre-commit): autofix * chore: fix wording Signed-off-by: Shumpei Wakabayashi <[email protected]> * chore: fix link Signed-off-by: Shumpei Wakabayashi <[email protected]> * chore: rename Signed-off-by: Shumpei Wakabayashi <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Takagi, Isamu <[email protected]> Co-authored-by: Lalith Vipulananthan <[email protected]> Co-authored-by: Kenji Miyake <[email protected]> Signed-off-by: Shark Liu <[email protected]> * fix(support): remove dead link (#116) * fix(support): remove dead link Signed-off-by: Takagi, Isamu <[email protected]> * Update docs/support/troubleshooting.md Co-authored-by: Lalith Vipulananthan <[email protected]> * Update troubleshooting.md Co-authored-by: Kenji Miyake <[email protected]> Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Shark Liu <[email protected]> * feat: add integrate autoware with your vehicle (#109) Signed-off-by: Shark Liu <[email protected]> * chore: sync files (#106) Signed-off-by: GitHub <[email protected]> Co-authored-by: kenji-miyake <[email protected]> Signed-off-by: Shark Liu <[email protected]> * docs: fix dead link in how-to-guides (#121) Signed-off-by: Shark Liu <[email protected]> Co-authored-by: Shark Liu <[email protected]> Signed-off-by: Shark Liu <[email protected]> * docs(installation): add arm64 docker installation (#120) * add arm64 docker installation Signed-off-by: Shark Liu <[email protected]> * ci(pre-commit): autofix * docs: remove the -arm64 tag from image tag Signed-off-by: Shark Liu <[email protected]> * ci(pre-commit): autofix * Update docs/installation/autoware/docker-installation.md Co-authored-by: Kenji Miyake <[email protected]> * Update docs/installation/autoware/docker-installation.md Co-authored-by: Kenji Miyake <[email protected]> Co-authored-by: Shark Liu <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Kenji Miyake <[email protected]> Signed-off-by: Shark Liu <[email protected]> * docs(tutorial): ss2 instructions (#118) * Update and rename rosbag-replay-simulation.md to Installation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Rename Installation.md to installation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Update and rename digital-twin-simulation.md to scenario-simulation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Update and rename planning-simulation.md to random-test-simulation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Update and rename scenario-simulation.md to scenario-test-simulation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Update .pages Signed-off-by: Wojciech Jaworski <[email protected]> * Update random-test-simulation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Update scenario-test-simulation.md Signed-off-by: Wojciech Jaworski <[email protected]> * ci(pre-commit): autofix Signed-off-by: Wojciech Jaworski <[email protected]> * Update random-test-simulation.md Signed-off-by: Wojciech Jaworski <[email protected]> * ci(pre-commit): autofix Signed-off-by: Wojciech Jaworski <[email protected]> * Update scenario-test-simulation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Update random-test-simulation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Add files via upload Signed-off-by: Wojciech Jaworski <[email protected]> * Update random-test-simulation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Update scenario-test-simulation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Update docs/tutorials/scenario-simulation/random-test-simulation.md Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Wojciech Jaworski <[email protected]> * Update docs/tutorials/scenario-simulation/scenario-test-simulation.md Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Wojciech Jaworski <[email protected]> * ci(pre-commit): autofix Signed-off-by: Wojciech Jaworski <[email protected]> * Update docs/tutorials/scenario-simulation/random-test-simulation.md Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Wojciech Jaworski <[email protected]> * Update docs/tutorials/scenario-simulation/scenario-test-simulation.md Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Wojciech Jaworski <[email protected]> * Update docs/tutorials/scenario-simulation/random-test-simulation.md Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Wojciech Jaworski <[email protected]> * Create rosbag-replay-simulation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Create digital-twin-simulation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Update .pages Signed-off-by: Wojciech Jaworski <[email protected]> * changed structure of files Signed-off-by: Wojciech Jaworski <[email protected]> * Update installation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Update installation.md Signed-off-by: Wojciech Jaworski <[email protected]> * ci(pre-commit): autofix Signed-off-by: Wojciech Jaworski <[email protected]> * fix .pages Signed-off-by: Kenji Miyake <[email protected]> Signed-off-by: Wojciech Jaworski <[email protected]> * move images Signed-off-by: Kenji Miyake <[email protected]> Signed-off-by: Wojciech Jaworski <[email protected]> * Update installation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Update scenario-test-simulation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Update random-test-simulation.md Signed-off-by: Wojciech Jaworski <[email protected]> * Update docs/tutorials/scenario-simulation/planning-simulation/random-test-simulation.md Co-authored-by: Kenji Miyake <[email protected]> Signed-off-by: Wojciech Jaworski <[email protected]> * Update docs/tutorials/scenario-simulation/planning-simulation/scenario-test-simulation.md Co-authored-by: Kenji Miyake <[email protected]> Signed-off-by: Wojciech Jaworski <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Lalith Vipulananthan <[email protected]> Co-authored-by: Kenji Miyake <[email protected]> Co-authored-by: Kenji Miyake <[email protected]> Signed-off-by: Shark Liu <[email protected]> * ci(pre-commit): autoupdate (#122) updates: - [github.com/scop/pre-commit-shfmt: v3.4.3-1 → v3.5.0-1](scop/pre-commit-shfmt@v3.4.3-1...v3.5.0-1) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Signed-off-by: Shark Liu <[email protected]> * docs(components): add vehicle dimensions page (#79) Signed-off-by: M. Fatih Cırıt <[email protected]> Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Shark Liu <[email protected]> * docs: replace "ROS2" with "ROS 2" (#133) * docs: replace "ROS2" with "ROS 2" Signed-off-by: Kenji Miyake <[email protected]> * fix invalid links Signed-off-by: Kenji Miyake <[email protected]> Signed-off-by: Shark Liu <[email protected]> * Perf: Add Ubuntu 2204 and ROS in prerequisites Signed-off-by: Shark Liu <[email protected]> * docs: add minimum hardware requirments Signed-off-by: Shark Liu <[email protected]> * docs(installation): fix styles Signed-off-by: Shark Liu <[email protected]> * ci(pre-commit): autofix Signed-off-by: Shark Liu <[email protected]> * docs(installation): fix style Signed-off-by: Shark Liu <[email protected]> * docs(installation): fix typo Signed-off-by: Shark Liu <[email protected]> * docs(concepts): add explanation of Core/Universe from AI and Auto (#132) * docs(concepts): add explanation of Core/Universe from AI and Auto Signed-off-by: mitsudome-r <[email protected]> * ci(pre-commit): autofix * docs: fix from spell-check Signed-off-by: mitsudome-r <[email protected]> * docs: apply suggested change Signed-off-by: mitsudome-r <[email protected]> * ci(pre-commit): autofix * Fix warning admonition code block Signed-off-by: Lalith Vipulananthan <[email protected]> Co-authored-by: Kenji Miyake <[email protected]> * Fix bullet points in issues list Co-authored-by: Kenji Miyake <[email protected]> * Update description of Autoware.AI Signed-off-by: Lalith Vipulananthan <[email protected]> Co-authored-by: Kenji Miyake <[email protected]> * Update description of issues with Autoware.AI development Signed-off-by: Lalith Vipulananthan <[email protected]> Co-authored-by: Kenji Miyake <[email protected]> * ci(pre-commit): autofix * Update Autoware.Auto descripiton to match Autoware.AI Signed-off-by: Lalith Vipulananthan <[email protected]> Co-authored-by: Kenji Miyake <[email protected]> * Update Autoware.Auto description Signed-off-by: Lalith Vipulananthan <[email protected]> Co-authored-by: Kenji Miyake <[email protected]> * docs(concepts): apply suggeted changes Signed-off-by: mitsudome-r <[email protected]> * ci(pre-commit): autofix Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Lalith Vipulananthan <[email protected]> Co-authored-by: Kenji Miyake <[email protected]> Signed-off-by: Shark Liu <[email protected]> * docs(how-to guides): add runninng Autoware without CUDA (#128) * added files Signed-off-by: kminoda <[email protected]> * ci(pre-commit): autofix * reflected reviews Signed-off-by: kminoda <[email protected]> * ci(pre-commit): autofix * added concrete configurations for object detection Signed-off-by: kminoda <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Signed-off-by: Shark Liu <[email protected]> * docs(how-to guides): how to integrate differential drive vehicles (#125) Signed-off-by: Shark Liu <[email protected]> * docs(design): add autoware design overview (#86) * docs(design): add autoware design Signed-off-by: Takamasa Horibe <[email protected]> * update .pages Signed-off-by: Takamasa Horibe <[email protected]> * update Signed-off-by: Takamasa Horibe <[email protected]> * update Signed-off-by: Takamasa Horibe <[email protected]> * update Signed-off-by: Takamasa Horibe <[email protected]> * add warning Signed-off-by: Takamasa Horibe <[email protected]> * rename directories Signed-off-by: Takamasa Horibe <[email protected]> * update Signed-off-by: Takamasa Horibe <[email protected]> * update Signed-off-by: Takamasa Horibe <[email protected]> * update Signed-off-by: Takamasa Horibe <[email protected]> * update Signed-off-by: Takamasa Horibe <[email protected]> * update Signed-off-by: Takamasa Horibe <[email protected]> * update Signed-off-by: Takamasa Horibe <[email protected]> * update Signed-off-by: Takamasa Horibe <[email protected]> Signed-off-by: Shark Liu <[email protected]> * docs(tutorials): update tutorials main page (#124) * docs(tutorials): rename tutorials section Renaming "Tutorials" section to "Simulation tutorials" Signed-off-by: Lalith Vipulananthan <[email protected]> * Revert folder and filename changes Signed-off-by: Lalith Vipulananthan <[email protected]> * Update contents of tutorials/index.md Signed-off-by: Lalith Vipulananthan <[email protected]> * ci(pre-commit): autofix * Update note about traffic light handling with the Planning Simulator Signed-off-by: Lalith Vipulananthan <[email protected]> * Add what localization and perception modules do * ci(pre-commit): autofix * Update docs/tutorials/index.md Add details about rosbag replay simulation Signed-off-by: Lalith Vipulananthan <[email protected]> * ci(pre-commit): autofix * Spelling fix Signed-off-by: Lalith Vipulananthan <[email protected]> * Fix planning simulator descriptin Removed note about traffic light handling and moved this to the main description. Signed-off-by: Lalith Vipulananthan <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Takeshi Ishita <[email protected]> Signed-off-by: Shark Liu <[email protected]> * docs: fix styles (#139) Signed-off-by: Kenji Miyake <[email protected]> Signed-off-by: Shark Liu <[email protected]> * feat: update planning architecture document (#135) * feat: update planning architecture document Signed-off-by: Takamasa Horibe <[email protected]> * fix typo Signed-off-by: Takamasa Horibe <[email protected]> * pre-commit Signed-off-by: Takamasa Horibe <[email protected]> * fix link Signed-off-by: Takamasa Horibe <[email protected]> * fix link Signed-off-by: Takamasa Horibe <[email protected]> * update Signed-off-by: Takamasa Horibe <[email protected]> Signed-off-by: Shark Liu <[email protected]> * ci(pre-commit): autofix Signed-off-by: Shark Liu <[email protected]> * Update docs/installation/index.md Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Shark Liu <[email protected]> * ci(pre-commit): autofix Signed-off-by: Shark Liu <[email protected]> * Perf: Add Ubuntu 2204 and ROS in prerequisites Signed-off-by: Shark Liu <[email protected]> * ci(pre-commit): autofix Signed-off-by: Shark Liu <[email protected]> * docs(installation): fix style Signed-off-by: Shark Liu <[email protected]> * docs(installation): fix typo Signed-off-by: Shark Liu <[email protected]> * docs: fix styles (#139) Signed-off-by: Kenji Miyake <[email protected]> Signed-off-by: Shark Liu <[email protected]> * ci(pre-commit): autofix Signed-off-by: Shark Liu <[email protected]> * Update docs/installation/index.md Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Shark Liu <[email protected]> * Update docs/installation/autoware/source-installation.md Co-authored-by: Lalith Vipulananthan <[email protected]> Signed-off-by: Shark Liu <[email protected]> * ci(pre-commit): autofix Signed-off-by: Shark Liu <[email protected]> Co-authored-by: Lalith Vipulananthan <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Kenji Miyake <[email protected]> Co-authored-by: Shumpei Wakabayashi <[email protected]> Co-authored-by: Takagi, Isamu <[email protected]> Co-authored-by: kminoda <[email protected]> Co-authored-by: awf-autoware-bot[bot] <94889083+awf-autoware-bot[bot]@users.noreply.github.com> Co-authored-by: kenji-miyake <[email protected]> Co-authored-by: Shark Liu <[email protected]> Co-authored-by: Wojciech Jaworski <[email protected]> Co-authored-by: Kenji Miyake <[email protected]> Co-authored-by: M. Fatih Cırıt <[email protected]> Co-authored-by: Ryohsuke Mitsudome <[email protected]> Co-authored-by: Takamasa Horibe <[email protected]> Co-authored-by: Takeshi Ishita <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Resolves #51.
Fixed some styles in accordance with the following guidelines:
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.