Skip to content

include patternfly-org in the docs api #234

Description

@patternfly-jira-sync

Scope
Make patternfly-org documentation content a first-class source in the patternfly-doc-core Docs API (discoverable via /api/[version]/[section]/[page]/… and related indexes)—the design guidelines, AI pages, foundations, etc. that today largely live under patternfly-org (e.g. documentation-site / site content) and that MCP still pins via docs.json.

Approach

  1. Inventory what org content the API build already gets (e.g. packages/site src/ in pf-docs.config.mjs) vs what still only exists in legacy documentation-site (or isn’t published to /api).
  2. Add or remap missing patternfly-org content collections into the doc-core site config so they participate in API index generation.
  3. Verify key org sections (e.g. AI overview, design guidelines, a sample component design page) appear in the API index and return body/text as expected in a local or preview API build.
  4. Document any gaps left for a follow-up (hosting/public URL, MCP cutover).

Jira Issue: PF-4531

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions