Add CLI tools usage examples and references to documentation #1560
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
1. Add CLI tools usage examples and references to documentation 2. Minor styling in Command-line interface section: make writing a bit more concise, use numbered nested list
Contributor
Author
|
Seems okay to me. Nested list rendering is a bit ugly. Still readable and also this problem should really be fixed in the renderer. Another concern I have is that I don't actually tell how to install documentation (the |
parulin
reviewed
Oct 28, 2025
Add code block inside nested list and collapse the highest level to make the article a bit shorter
parulin
reviewed
Oct 28, 2025
Tell the command, not the word
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.
I can't read documentation contribution guides because links in CONTRIBUTING.md and README.md are currently broken lolol
p.s. Idea comes from here