patternfly / patternfly/patternfly-org

Implement JSON Schema Generation for react components.

Open
#4,705 0 comments 1 reaction 1 assignee View on GitHub

@jenny-s51 is already working on this.

Since Sep 3, 2025.

PF Team
Dominant language
JavaScript
Stars
74
Forks
147
Avg merge
4d 11h
Merged PRs (30d)
2

Description

In order to support component validation for AI, the team is currently requesting that we generate a JSON schema for our react components as part of our build process. This can be done with the new documenation framework. We would just need to create a single file with the props and make that available to consumers.

  • Update documentation so consumers know it's available and how to use it.

  • Test and verify that this package can be used by an LLM

  • This schema should be able to be consumed by dynamic components that are being used to generate components using AI.


Jira Issue: PF-2391

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.