feat: remove description about divided maps and put link instead #429
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: kminoda <koji.minoda@tier4.jp>
alanmengg
pushed a commit
to alanmengg/autoware-documentation
that referenced
this pull request
Aug 2, 2023
…owarefoundation#429) Signed-off-by: kminoda <koji.minoda@tier4.jp> Signed-off-by: guiping meng <alan.meng@autocore.ai>
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
Related to #424.
Current map design doc include a specific guideline for how to divide maps for Autoware, which seems to be out of the scope of the design doc. Furthermore, the same description is included in the readme in Autoware Universe, making it more difficult to maintain both documentation properly.
Thus, I'd like to remove the specific description in Autoware Documentation and put a link to readme instead.
One of the alternatives would be to leave this documentation as it is, and put the link to this page in Readme instead. However, given that the most of the package description is included in Readme and not in Documentation page, I'd like to take the former approach to be consistent with other packages.
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.