wp-cli / handbook

📖 Complete documentation for WP-CLI

Home Page:https://make.wordpress.org/cli/handbook/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Markdown files missing in handbook

ernilambar opened this issue · comments

Bug Report

Describe the current, buggy behavior

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

  • https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/scaffold\/package-tests.md Ref
  • https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/scaffold\/package-readme.md Ref

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.

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.

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/

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

cc @danielbachhuber @schlessera

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

Depends upon #507