Improvements to the CLI documentation #912
Merged
Conversation
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
Julow
force-pushed
the
improve_cli_doc
branch
from
e1b182a to
cf62b94
Compare
The sections allow to quickly find the important commands. The "Legacy pipeline" section give less importances to the no longer recommended commands.
Document the dependencies in the compile and link steps. Fill the missing documentation. Improve consistency and formatting.
Sections are assigned while defining the list to make sure they are still in sync.
Julow
force-pushed
the
improve_cli_doc
branch
from
cf62b94 to
55c410b
Compare
|
Let's have this one for now, and we can figure out the extra docs and their generation separately. |
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.
Sort commands in sections and improve the documentation. It's #903 without the new documentation page.