Skip to content

[docs] Adding manifest.json for handbook structure - #3267

Merged
akirk merged 6 commits into
trunkfrom
adding-handbook-manifest
Jul 15, 2026
Merged

[docs] Adding manifest.json for handbook structure#3267
akirk merged 6 commits into
trunkfrom
adding-handbook-manifest

Conversation

@fellyph

@fellyph fellyph commented Feb 12, 2026

Copy link
Copy Markdown
Collaborator

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.

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.
Copilot AI review requested due to automatic review settings February 12, 2026 20:31

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.json file 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.

Comment thread packages/docs/site/manifest.json Outdated
fellyph and others added 2 commits February 12, 2026 22:10
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@fellyph
fellyph requested review from a team and ashfame June 4, 2026 12:49
@github-actions github-actions Bot added the [Type] Documentation Improvements or additions to documentation label Jun 4, 2026

@ashfame ashfame left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Findings:

  • High: packages/docs/site/manifest.json omits documentation pages that are already present in sidebars.js, so consumers that use this manifest as the handbook structure would silently drop existing pages. Missing sidebar pages include main/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, and developers/06-apis/javascript-api/09-php-extension-dependencies.md.

  • Medium: the Blueprint navigation order in the manifest differs from sidebars.js: the manifest lists blueprints/using-blueprints before blueprints/data-format, while the current sidebar orders data-format before using-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.

@ashfame

ashfame commented Jun 4, 2026

Copy link
Copy Markdown
Member

@fellyph Feel free to use the above findings as a heads up and then proceed.

@akirk akirk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets merge it!

@akirk
akirk merged commit e6bf3bf into trunk Jul 15, 2026
53 checks passed
@akirk
akirk deleted the adding-handbook-manifest branch July 15, 2026 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Documentation Improvements or additions to documentation

4 participants