Skip to content

feat(mcp): add doc facet frontmatter scheme and versioning IA#48

Merged
lhagenWP merged 1 commit into
mainfrom
mcp-docs-facets-ia
Jun 16, 2026
Merged

feat(mcp): add doc facet frontmatter scheme and versioning IA#48
lhagenWP merged 1 commit into
mainfrom
mcp-docs-facets-ia

Conversation

@trichardswp

@trichardswp trichardswp commented Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Summary

Updates API Docs with the structure which is required to provide this documentation in machine readable form.
Allows this documentation to be used to power the MCP documentation in a forthcoming update.

Changes

  • Extend the Fumadocs frontmatter schema with lifecycle/topic/keywords (src/lib/facets.ts, source.config.ts); enforced at build.
  • Inject facets into the auto-generated OpenAPI reference pages during generation via a per-path map (scripts/generators/openapi/openapi.facets.ts + generator wiring), with unit tests.
  • Apply facet frontmatter to authored person, property, and operational reference pages.
  • Extract Versioning & Breaking Changes from the Support page into its own references group (content/docs/references/versioning/), leaving a short pointer behind.
  • Surface trial exhaustion ("Limit Exceeded") in rate-limits.mdx with clearer wording and search keywords.

Add lifecycle/topic/keywords facets to the docs source schema so the
build-time MCP corpus generator can read them off page data without
scraping MDX.

Apply facets to authored person, property, and operational reference
pages. The auto-generated OpenAPI reference pages get facets injected
during generation via a per-path map, so hand-edits are never needed.

Extract Versioning & Breaking Changes from the Support page into its
own references group, and surface trial exhaustion (Limit Exceeded) in
rate limits with clearer wording and search keywords.
@trichardswp trichardswp requested a review from lhagenWP June 16, 2026 23:36
@lhagenWP lhagenWP merged commit d7605c2 into main Jun 16, 2026
1 check passed
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.

2 participants