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

fix: Improved readme and help text #200

Merged
merged 2 commits into from
May 21, 2019
Merged

fix: Improved readme and help text #200

merged 2 commits into from
May 21, 2019

Conversation

timhaines
Copy link
Contributor

Reformats some wording, adds context around finalizing a build.

@djones
Copy link
Contributor

djones commented May 14, 2019

@timhaines that bit of the docs is autogenerated by Oclif. To update the wording, you'll want to update the description for each command, e.g. https://github.com/percy/percy-agent/blob/master/src/commands/exec.ts#L7

This has an added bonus that you'll be fixing not only the readme but the help text for the CLI 😄

Note the readme won't autogenerate until the release flow is run and that only happens when a new version is shipped. Technically I think this PR title should start with docs: and that won't ship a new version. If you feel strongly that you want to ship this update to the readme soon, feel free to change this PR to have fix: at the front.

Side note: in the raw readme there's some magic comments like

<!-- commands -->
Command docs are generated into this space.
<!-- commandsstop -->

and so that's how the auto doc generation works.

@djones djones changed the title Update README.md fix: Improved readme and help text May 21, 2019
Copy link
Contributor

@djones djones left a comment

Choose a reason for hiding this comment

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

🍍 LGTM

@timhaines timhaines merged commit 34c066c into master May 21, 2019
@timhaines timhaines deleted the readme-update branch May 21, 2019 21:41
djones pushed a commit that referenced this pull request May 21, 2019
## [0.4.9](v0.4.8...v0.4.9) (2019-05-21)

### Bug Fixes

* Improved readme and help text ([#200](#200)) ([34c066c](34c066c))
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.

None yet

2 participants