wp-cli / handbook

📖 Complete documentation for WP-CLI
https://make.wordpress.org/cli/handbook/
MIT License
188 stars 330 forks source link

Markdown files missing in handbook #485

Closed ernilambar closed 2 months ago

ernilambar commented 6 months ago

Bug Report

Describe the current, buggy behavior

In commands-manifest.json, few markdown_source URLs are not working. Eg:

Is this the reason pages like https://developer.wordpress.org/cli/commands/scaffold/package-tests/ not showing the docs properly?

Describe what you would expect as the correct outcome

Handbook pages should display correct and full command docs.

swissspidy commented 6 months ago

The handbook should only contain documentation for bundled commands. scaffold-package-tests isn't bundled, so it shouldn't be mentioned in commands-manifest.json.

ernilambar commented 6 months ago

But we have included other non bundled commands like profile, admin, etc. Those are kept in the manifest and pages are also populated as expected. Eg: https://developer.wordpress.org/cli/commands/profile/

swissspidy commented 5 months ago

Hmm interesting. I don't know where the line was drawn there 🤷

cc @danielbachhuber @schlessera

danielbachhuber commented 5 months ago

I'm open to including the others if we communicate that the package needs to be installed independently.

ernilambar commented 3 months ago

Depends upon https://github.com/wp-cli/handbook/issues/507

ernilambar commented 2 months ago

This is now unblocked by https://github.com/wp-cli/handbook/issues/507

ernilambar commented 2 months ago

It seems those missing scaffold package markdown files are ignored in .gitignore.

commands/scaffold/package*

Ref: https://github.com/wp-cli/handbook/blob/main/.gitignore#L12