search

stacks-network / stacks-blockchain-docker

Stacks-blockchain with API using docker compose
GNU General Public License v3.0
27 stars 37 forks source link

docs: remove $ from cmd so it is easier to paste in terminal #39

Closed Akirtovskis closed 3 years ago

Akirtovskis commented 3 years ago

Just a suggestion as I found it a bit tedious to delete $ after pasting every single command into my terminal.

Description

1. Motivation for change Easier to run commands after pasting into the terminal 2. What was changed Removed the $ sign from the setup commands 3. How do these changes impact application developers Speeds up their experience

CLAassistant commented 3 years ago

CLA assistant check
All committers have signed the CLA.

Akirtovskis commented 3 years ago

@wileyj heya, tagging you here because I saw that you have most contributions in this repo.

wileyj commented 3 years ago

@Akirtovskis Thanks for the PR!

The reason the $ are listed here is quite simply - that's the way it's been done elsewhere in a lot of our docs. I agree with this change, but before I can merge it I want to discuss with other team members to see if we should globally institute this.

Akirtovskis commented 3 years ago

Thanks for getting back so quickly and that absolutely makes sense. If you decide that there's a need to change this globally I am happy to help with that.

wileyj commented 3 years ago

will do! i'm in fact creating a new issue in our docs repo to address this. Once i have that ticket created i'll share here and we can merge this.

thanks again!