-
Notifications
You must be signed in to change notification settings - Fork 53
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
Add documentation for CLI commands #345
Add documentation for CLI commands #345
Conversation
e9ba092
to
bbdd6d6
Compare
b1f01d0
to
4fc7149
Compare
I developed simple helper CLI command to generate doc for the CLI commands. https://github.com/ernilambar/pc-cli-docs So doc generation is now semi-automatic instead of manual. Preview: https://github.com/ernilambar/plugin-check/blob/38-add-cli-documentation/docs/CLI.md There is no |
It would be better to contribute to https://github.com/wp-cli/scaffold-package-command to make it easier to generate documentation for commands within a plugin. Kudos for building something custom. However, long term it is not viable to fork and maintain a custom tool that just works with Plugin Check. Especially since these commands don't change frequently. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR! I've left some minor feedback for your consideration.
4fc7149
to
3c405cf
Compare
Fixes #38