[docs] Adding manifest.json for handbook structure - #3267
Conversation
This commit introduces a new manifest.json file that outlines the structure and content of the WordPress Playground documentation. It includes sections for the handbook, guides, contributing, resources, and blueprints, each with associated titles, slugs, and markdown sources. This addition aims to enhance the organization and accessibility of the documentation.
There was a problem hiding this comment.
Pull request overview
This PR introduces a manifest.json file to define the organizational structure of WordPress Playground documentation, including handbooks, blueprints, and developer resources. The manifest establishes a hierarchical content structure with metadata for titles, slugs, markdown sources, parent-child relationships, and ordering.
Changes:
- Added a new
manifest.jsonfile that catalogs all documentation pages with their structural relationships and source locations
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
ashfame
left a comment
There was a problem hiding this comment.
Findings:
-
High:
packages/docs/site/manifest.jsonomits documentation pages that are already present insidebars.js, so consumers that use this manifest as the handbook structure would silently drop existing pages. Missing sidebar pages includemain/troubleshooting.md,main/guides/php-code-snippets.md,main/guides/agent-skill-wp-playground.md,main/guides/programmatic-playground-cli.md,main/guides/phpunit-testing.md,main/guides/e2e-testing-with-playwright.md,developers/06-apis/sites-api/01-index.md,developers/06-apis/javascript-api/07-php-extensions.md,developers/06-apis/javascript-api/08-build-php-extensions.md, anddevelopers/06-apis/javascript-api/09-php-extension-dependencies.md. -
Medium: the Blueprint navigation order in the manifest differs from
sidebars.js: the manifest listsblueprints/using-blueprintsbeforeblueprints/data-format, while the current sidebar ordersdata-formatbeforeusing-blueprints. That would produce a different handbook navigation order than the docs site.
Validation: the manifest parses as JSON, and npm exec nx run docs-site:check-orphan-pages passes against the current sidebar/docs set.
|
@fellyph Feel free to use the above findings as a heads up and then proceed. |
This commit introduces a new manifest.json file that outlines the structure and content of the WordPress Playground documentation. It includes sections for the handbook, guides, contributing, resources, and blueprints, each with associated titles, slugs, and markdown sources. This addition aims to enhance the organization and accessibility of the documentation.