Skip to content

include patternfly-org in the docs api #234

Closed
Closed
include patternfly-org in the docs api#234

Description

@patternfly-jira-sync
patternfly-jira-sync
opened on Aug 5, 2026

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

Activity

  1. coderabbitai commented on Aug 5, 2026

    @coderabbitai
    coderabbitaiBot
    on Aug 5, 2026 – with coderabbitai
    Contributor
    🔗 Related PRs

    #221 - feat(API): [PF-3167] Add component-index.json API endpoint for MCP [merged]
    #229 - feat(API): Add API only build mode [merged]

    📝 Issue Planner

    Check the box below or use the @coderabbitai plan command to generate an implementation plan and prompts that you can use with your favorite coding assistant.

    • Create Plan
    🧪 Issue enrichment is currently in open beta.

    You can configure auto-planning by selecting labels in the issue_enrichment configuration.

    To disable automatic issue enrichment, add the following to your .coderabbit.yaml:

    issue_enrichment:
  auto_enrich:
    enabled: false

    💬 Have feedback or questions? Drop into our discord!

  2. patternfly-build
    added this to PatternFly Issueson Aug 5, 2026
  3. github-project-automation
    moved this to Needs triage in PatternFly Issueson Aug 5, 2026
  4. patternfly-jira-sync
    closed this as completedon Sep 15, 2026

  5. patternfly-jira-sync commented on Sep 15, 2026

    @patternfly-jira-sync
    patternfly-jira-sync
    on Sep 15, 2026
    Author

    Closed via Jira sync - Jira issue PF-4531 was closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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