Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update README.md farming edits #211

Merged
merged 1 commit into from
Nov 5, 2021
Merged

Conversation

barriebyron
Copy link
Contributor

Description

README edits, see comments

I suggest that you use code fence tick marks for each command and then use plain text between

introduce each command and provide a transition before the output and resulting files

When showing a command, explain the command first by talking about what it does. Then show the command. Then show its output in a separate output block

closes part of #172

Tasks

  • [ ]

References

see and apply the Technical content style guidance for Farming


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Appropriate labels applied
  • Targeted PR against correct branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

@barriebyron barriebyron requested a review from jaybxyz November 4, 2021 03:16
@barriebyron barriebyron requested a review from dongsam as a code owner November 4, 2021 03:16
@barriebyron barriebyron self-assigned this Nov 4, 2021
docs/How-To/cli/README.md Show resolved Hide resolved
docs/How-To/cli/README.md Show resolved Hide resolved
docs/How-To/cli/README.md Show resolved Hide resolved
docs/How-To/cli/README.md Show resolved Hide resolved
docs/How-To/cli/README.md Show resolved Hide resolved
docs/How-To/cli/README.md Show resolved Hide resolved
@jaybxyz jaybxyz merged commit cd2b333 into main Nov 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants