Skip to content

Conversation

@colinmurphy
Copy link
Member

@colinmurphy colinmurphy commented Oct 23, 2025

Description

As part of the roadmap https://github.com/wpengine/faustjs/blob/canary/ROADMAP.md and the goal "Developer documentation for the Headless WordPress Toolkit" I have fixed the paths for the nav.json and also added metadata for the different docs markdown files.

Related Issue

Dependant PRs

Type of Change

  • ✅ Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactoring (no functional changes)
  • 📄 Example update (no functional changes)
  • 📝 Documentation update
  • 🔍 Performance improvement
  • 🧪 Test update

How Has This Been Tested?

Screenshots

Checklist

  • I have read the CONTRIBUTING document
  • My code follows the project's coding standards
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works (if applicable)
  • Any dependent changes have been highlighted, merged or published

@changeset-bot
Copy link

changeset-bot bot commented Oct 23, 2025

⚠️ No Changeset found

Latest commit: 21b9d08

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Introduced YAML frontmatter to multiple documentation files, specifying title and description for improved SEO and content organization. This change enhances discoverability and provides clearer context for each guide.
@colinmurphy colinmurphy changed the title Updated paths for toolkti nav.json to be /toolkit/ not /docs/ chore: Updated paths for toolkti nav.json and added metadata for docs Oct 23, 2025
@colinmurphy colinmurphy marked this pull request as ready for review October 23, 2025 16:45
@colinmurphy colinmurphy requested a review from a team as a code owner October 23, 2025 16:45
@colinmurphy colinmurphy enabled auto-merge October 23, 2025 16:45
@colinmurphy colinmurphy disabled auto-merge October 23, 2025 18:14
@colinmurphy colinmurphy changed the title chore: Updated paths for toolkti nav.json and added metadata for docs chore: Updated paths for toolkit nav.json and added metadata for docs Oct 23, 2025
@colinmurphy colinmurphy added this pull request to the merge queue Oct 24, 2025
Merged via the queue into main with commit 95f2396 Oct 24, 2025
2 checks passed
@colinmurphy colinmurphy deleted the chore-update-docs-nav.json branch October 24, 2025 09:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants