patternfly / patternfly/patternfly-doc-core

Create documentation API for use by MCP servers and other generative AI tools

Open
#167 1 comment 0 reactions 1 assignee View on GitHub

@wise-king-sullyman is already working on this.

Since Jul 13, 2026.

epic PF Team
Dominant language
TypeScript
Stars
2
Forks
11
Avg merge
5d 15h
Merged PRs (30d)
1

Description

In order to better support of AI applications such as MCP servers, the current documentation site needs to be output in a more machine readable format via an API which returns plain text or JSON representations of our docs.

APIs should support versioning based on the associated PF major release version (i.e. v5, v6). Only the most recent minor release of each major needs to be supported.

The API should be self documenting in a manner that hitting the API root should explain what endpoints are available and what they each provide.


Jira Issue: PF-2765

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.