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

Markdown files missing in handbook #485

Open
2 tasks done
ernilambar opened this issue Mar 26, 2024 · 4 comments
Open
2 tasks done

Markdown files missing in handbook #485

ernilambar opened this issue Mar 26, 2024 · 4 comments

Comments

@ernilambar
Copy link
Contributor

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.

@swissspidy
Copy link
Member

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
Copy link
Contributor Author

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
Copy link
Member

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

cc @danielbachhuber @schlessera

@danielbachhuber
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants