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

Add documentation for CLI commands #345

Merged
merged 3 commits into from
Jan 22, 2024

Conversation

ernilambar
Copy link
Member

Fixes #38

docs/wp-plugin-check.md Outdated Show resolved Hide resolved
@ernilambar ernilambar force-pushed the 38-add-cli-documentation branch 3 times, most recently from b1f01d0 to 4fc7149 Compare January 22, 2024 06:14
@ernilambar
Copy link
Member Author

ernilambar commented Jan 22, 2024

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.
It would be great if we could find a way incorporate this command in the trunk and exclude it when we deploy to SVN in the plugin directory.

Preview: https://github.com/ernilambar/plugin-check/blob/38-add-cli-documentation/docs/CLI.md

There is no EXAMPLES section for wp plugin list-checks because it is missing in the command itself. I have created separate PR to add example. #396

@ernilambar ernilambar changed the title Add documentation for plugin check command Add documentation for CLI commands Jan 22, 2024
@swissspidy
Copy link
Member

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.

Copy link
Member

@mukeshpanchal27 mukeshpanchal27 left a 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.

docs/CLI.md Show resolved Hide resolved
docs/CLI.md Outdated Show resolved Hide resolved
@mukeshpanchal27 mukeshpanchal27 merged commit 3202dc9 into WordPress:trunk Jan 22, 2024
1 check passed
@ernilambar ernilambar deleted the 38-add-cli-documentation branch January 22, 2024 11:14
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.

Create documentation for CLI command
3 participants