Use in-code documentation for CLI documentation in README.md#86
Merged
alexevanczuk merged 8 commits intomainfrom Apr 17, 2023
Merged
Use in-code documentation for CLI documentation in README.md#86alexevanczuk merged 8 commits intomainfrom
alexevanczuk merged 8 commits intomainfrom
Conversation
alexevanczuk
force-pushed
the
ae-make-docs-consistent
branch
from
a2ee332 to
64baadb
Compare
alexevanczuk
force-pushed
the
ae-make-docs-consistent
branch
from
64baadb to
afca4a1
Compare
shageman
approved these changes
Apr 17, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The idea behind this PR is to make it easier to keep the README documentation on the CLI up to date.
Right now, we need to redundantly specify documentation for
bin/packswhen it is already in the CLI when usingbin/packs -horbin/packs help create(for example).While we could simply not document it in the README, it is useful for folks to be able to use the README to know what they can do before installing a gem (or even after, as some folks prefer the README over CLI docs).
Instead, this PR uses a little generator to ensure the README is up-to-date and gives a script,
OVERWRITE=1 ruby docs/verify_docs.rb, that automatically updates the docs.If a user does not update the docs using this script after adding a CLI command, they will be met with this message in CI:
