docs(planning): update documentation structure #5694
Merged
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
zulfaqar-azmi-t4
added
type:documentation
github-actions
bot
removed
the
type:documentation
|
Documentation URL: https://autowarefoundation.github.io/autoware.universe/pr-5694/ |
zulfaqar-azmi-t4
force-pushed
the
documentation-index
branch
2 times, most recently
from
482efca to
2ac083b
Compare
Signed-off-by: Zulfaqar Azmi <[email protected]>
zulfaqar-azmi-t4
force-pushed
the
documentation-index
branch
from
e7bbc47 to
838474a
Compare
zulfaqar-azmi-t4
changed the title
zulfaqar-azmi-t4
added
the
run:build-and-test-differential
Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]>
Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]>
Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]>
Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]>
github-actions
bot
added
type:documentation
Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]>
TakaHoribe
reviewed
Dec 4, 2023
Co-authored-by: Takamasa Horibe <[email protected]>
Co-authored-by: Takamasa Horibe <[email protected]>
kyoichi-sugahara
pushed a commit
to kyoichi-sugahara/autoware.universe
that referenced
this pull request
Dec 5, 2023
* docs(planning): update documentation structure Signed-off-by: Zulfaqar Azmi <[email protected]> * fix typo Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> * move sampling based planner to motion planning Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> * try with link Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> * planning folder on top Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> * planning at top page Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> --------- Signed-off-by: Zulfaqar Azmi <[email protected]> Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]>
danielsanchezaran
pushed a commit
to tier4/autoware.universe
that referenced
this pull request
Dec 15, 2023
* docs(planning): update documentation structure Signed-off-by: Zulfaqar Azmi <[email protected]> * fix typo Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> * move sampling based planner to motion planning Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> * try with link Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> * planning folder on top Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> * planning at top page Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> --------- Signed-off-by: Zulfaqar Azmi <[email protected]> Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]>
karishma1911
pushed a commit
to Interplai/autoware.universe
that referenced
this pull request
Jun 3, 2024
* docs(planning): update documentation structure Signed-off-by: Zulfaqar Azmi <[email protected]> * fix typo Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> * move sampling based planner to motion planning Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> * try with link Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> * planning folder on top Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> * planning at top page Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> --------- Signed-off-by: Zulfaqar Azmi <[email protected]> Signed-off-by: Muhammad Zulfaqar Azmi <[email protected]> Signed-off-by: karishma <[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
Navigating the planning module documentation is quite challenging because the current document's hierarchical structure is based on the alphabetical order of folders, and on whether a docs folder exists in the module's folder.
The behavior path planner and behavior velocity planner are particularly affected, which might cause confusion for users about which document they should view first to understand the planning modules.
This PR aims to resolve this issue by manually specifying the order of the documents.
Tests performed
Not applicable.
Effects on system behavior
Not applicable.
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 PR 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.