Fix docs to make copying commands easier #859
Merged
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
Problem: Commands and their output were saved in the same block, making it difficult for users to simply copy the commands. Solution: Separate commands and their output into separate blocks in the documentation.
github-actions
bot
added
the
documentation
|
Wasn't totally sure the best way visually to format the command followed by the output, so took a stab at it. Open to feedback. |
kate-osborn
requested changes
Jul 13, 2023
lucacome
reviewed
Jul 13, 2023
There was a problem hiding this comment.
Nice! I added a few suggestions but GitHub keeps lagging so didn't add it in all places 😞
There's a list of supported languages here in case you didn't know https://github.com/github-linguist/linguist/blob/master/lib/linguist/languages.yml
sjberman
force-pushed
the
docs/improve-cli-instructions
branch
from
18b56b9
to
05b03aa
Compare
sjberman
force-pushed
the
docs/improve-cli-instructions
branch
from
05b03aa
to
e8b4983
Compare
kate-osborn
approved these changes
Jul 13, 2023
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.
Problem: Commands and their output were saved in the same block, making it difficult for users to simply copy the commands.
Solution: Separate commands and their output into separate blocks in the documentation.
Closes #543
Checklist
Before creating a PR, run through this checklist and mark each as complete.