We have prior art where we've typically used a code block like this to show terminal or bash commands:
However, Akirtovskis mentioned in stacks-network/stacks-blockchain-docker#39 that it would make things easier to remove the $ from terminal/bash, like this:
Personally, I agree with this approach - the only reason I had added the $ is because of prior docs/readme's that we've published where the $ exists.
To keep this issue easily scoped, we should go through existing docs here and remove the $ or any other shell/terminal identifier ( % is another example).
Later, it would be nice to work on a style-guide that we use here with the goal of standardizing how we create docs with the goal of making them easy and accessible. ( @pgray-hiro )
We have prior art where we've typically used a code block like this to show terminal or bash commands:
However,
Akirtovskismentioned in stacks-network/stacks-blockchain-docker#39 that it would make things easier to remove the$from terminal/bash, like this:Personally, I agree with this approach - the only reason I had added the
$is because of prior docs/readme's that we've published where the$exists.To keep this issue easily scoped, we should go through existing docs here and remove the
$or any other shell/terminal identifier (%is another example).Later, it would be nice to work on a style-guide that we use here with the goal of standardizing how we create docs with the goal of making them easy and accessible. ( @pgray-hiro )