handbook icon indicating copy to clipboard operation
handbook copied to clipboard

Markdown files missing in handbook

Open ernilambar opened this issue 10 months ago • 5 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.

ernilambar avatar Mar 26 '24 06:03 ernilambar

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.

swissspidy avatar Mar 26 '24 09:03 swissspidy

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/

ernilambar avatar Mar 26 '24 12:03 ernilambar

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

cc @danielbachhuber @schlessera

swissspidy avatar Apr 26 '24 12:04 swissspidy

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

danielbachhuber avatar Apr 26 '24 21:04 danielbachhuber

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

ernilambar avatar Jun 10 '24 06:06 ernilambar

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

ernilambar avatar Aug 01 '24 09:08 ernilambar

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

ernilambar avatar Aug 01 '24 10:08 ernilambar