docs: Improve documentation structure #16
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
godlygeek
force-pushed
the
restructure_documentation
branch
from
085da0e to
2cd3a61
Compare
Contributor
Author
|
Docs generated from this PR can be viewed here, which will certainly be much easier than trying to read this diff 😅 |
In addition to some rephrasing and polishing of the wording of the documentation, overhaul the structure. Remove the dedicated pages showing how to run each of the CLI commands, instead merging them into a section on the most closely related page. Create a new page for the `run` subcommand that describes all its possible modes, but link to a separate page for detailed descriptions about "live" mode. Move the "live mode" page into the reporters section, since it's essentially a reporter.
pablogsal
force-pushed
the
restructure_documentation
branch
from
2cd3a61 to
05f0d90
Compare
pablogsal
approved these changes
Apr 20, 2022
Member
pablogsal
left a comment
pablogsal
left a comment
There was a problem hiding this comment.
LGTM
This is great. Thanks a lot @godlygeek!
I have made some small changes and reordered a section.
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
In addition to some rephrasing and polishing of the wording of the
documentation, overhaul the structure. Remove the dedicated pages
showing how to run each of the CLI commands, instead merging them into
a section on the most closely related page. Create a new page for the
runsubcommand that describes all its possible modes, but link toa separate page for detailed descriptions about "live" mode. Move the
"live mode" page into the reporters section, since it's essentially
a reporter.