docs: add info to support nested workflow, part 1 #313
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: Minae Lee <[email protected]>
|
This looks fine to me, but I'm going to wait for the init removal to be processed as there might be some conflicts and this will be the easier PR to change. There might be some other changes associated with that change that need to be mentioned - though nothing occurs to me right now. |
|
just in case, #314 is merged |
|
As I thought, there are lots of conflicts. If you don't have time to resolve these @minaelee I can take your work here and rebase it in a new PR - as it was my decision to delay this merge. |
No worries, resolved! |
SecondSkoll
approved these changes
Dec 13, 2024
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.
Updates to support the nested workflow where the docs are always in a subfolder (such as "docs/") of a project's root folder. This PR ensures that commands are accompanied by instructions on where to perform them (any location if a system-wide command; within the documentation folder if that is necessary).
Also improved the explanation about integration with the main Makefile of the project; made some minor edits, such as using
folderconsistently instead offolderanddirectoryinconsistently; added an example of how to configure the documentation folder in RTD.Note: Other docs pages still require updates to support the nested workflow, but they are blocked by waiting for the init.sh script to be replaced with manual instructions.