Skip to content
This repository has been archived by the owner on Jan 11, 2024. It is now read-only.

Improve formatting of commands and examples #169

Merged
merged 4 commits into from
Apr 20, 2023
Merged

Conversation

jsoares
Copy link
Contributor

@jsoares jsoares commented Apr 20, 2023

  • Removes leading prompt from bash blocks
  • Separates examples into console blocks

This was a bit rushed so some decisions may have been suboptimal given there are some edge cases.

For the now-separate examples, we should add the expected outcome -- which we have in some cases, not in others. But this should already improve quality of life for the reader, so I wouldn't block on re-executing things for output.

@jsoares jsoares requested review from adlrocha and aakoshh April 20, 2023 11:04
README.md Outdated Show resolved Hide resolved
docs/subnet.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
Copy link
Contributor

@aakoshh aakoshh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks for jumping on this ❤️

jsoares and others added 2 commits April 20, 2023 14:04
Co-authored-by: Akosh Farkash <aakoshh@gmail.com>
@jsoares
Copy link
Contributor Author

jsoares commented Apr 20, 2023

Thanks for the review @aakoshh! Changes made, will merge.

@jsoares jsoares merged commit 33760d3 into main Apr 20, 2023
@jsoares jsoares deleted the jsoares/docs-format branch April 20, 2023 12:08
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants