Design for per-package documentation system#306
Merged
maryaB-osr merged 6 commits intogh-pagesfrom Oct 30, 2020
Merged
Conversation
Signed-off-by: maryaB-osr <marya@openrobotics.org>
Signed-off-by: maryaB-osr <marya@openrobotics.org>
Signed-off-by: maryaB-osr <marya@openrobotics.org>
Signed-off-by: maryaB-osr <marya@openrobotics.org>
|
This pull request has been mentioned on ROS Discourse. There might be relevant details there: https://discourse.ros.org/t/request-for-comment-per-package-documentation-requrements/16699/2 |
clalancette
reviewed
Oct 22, 2020
Contributor
clalancette
left a comment
There was a problem hiding this comment.
I've got a few minor things inline to fix up.
One other thing: I think it would be nice in the "Buildfarm" section to briefly describe how we think cross-referencing between sibling packages will work. That is, we may need to run multiple passes to get the documentation into an "eventually consistent" state. How exactly that will be done is TBD.
Signed-off-by: maryaB-osr <marya@openrobotics.org>
Signed-off-by: maryaB-osr <marya@openrobotics.org>
clalancette
approved these changes
Oct 30, 2020
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
The first iteration of this document: #301
Some slight changes have been made to the Requirements sections, but the focus of this PR is the design section describing how the requirements will be met for the new per-package documentation system.
Signed-off-by: maryaB-osr marya@openrobotics.org