-
Notifications
You must be signed in to change notification settings - Fork 147
docs(AI): add AI development tools page and replace stale references #4991
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
5dc984d
docs(AI): add AI development tools page and replace stale references
jpuzz0 651577a
docs(AI): address review feedback — wording, formatting, capitalization
jpuzz0 e2137cc
docs(AI): remove plugin table to avoid maintenance burden
jpuzz0 69e61d5
docs(AI): rename page to Marketplace, update all references
jpuzz0 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
packages/documentation-site/patternfly-docs/content/AI/marketplace/marketplace.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| id: Marketplace | ||
| section: AI | ||
| sortValue: 3 | ||
| --- | ||
|
|
||
| The [PatternFly AI Helpers](https://github.com/patternfly/ai-helpers) marketplace is an open source collection of **plugins** for AI coding tools like [Claude Code](https://docs.anthropic.com/en/docs/claude-code) and [Cursor](https://www.cursor.com/). These plugins provide models with knowledge and skills that are tailored to PatternFly workflows, so your AI tools can generate more accurate solutions that follow our best practices. | ||
|
|
||
| Whether you're building PatternFly UIs, prototyping in code, or evaluating AI tooling for your team, our AI Helpers can simplify and enhance your experience. | ||
|
|
||
| With AI Helpers installed, you can expect a few benefits when using generative AI: | ||
|
|
||
| - More consistent use of PatternFly components and patterns. | ||
| - Faster prototyping and development cycles. | ||
| - Fewer common implementation mistakes. | ||
| - Built-in awareness of PatternFly coding standards, accessibility, and design tokens. | ||
|
|
||
| ## What plugins are available? | ||
|
|
||
| The AI Helpers marketplace is organized into plugins, each focused on a different area of PatternFly — from building and testing React components, to working with design tokens and accessibility, to reviewing Figma changes. New plugins are added regularly as the community contributes. | ||
|
|
||
| We are actively maintaining and evolving our plugins based on the needs of our maintainers and users. For the current list of plugins, view our [plugin catalog](https://github.com/patternfly/ai-helpers/blob/main/PLUGINS.md). | ||
|
|
||
| ## Get started | ||
|
|
||
| You can use our plugins with the AI coding tool of your choice, such as Claude Code or Cursor, by following these onboarding steps. | ||
|
|
||
| For the best experience, set up the [PatternFly MCP server](https://github.com/patternfly/patternfly-mcp) to give AI tools direct access to PatternFly component documentation, prop schemas, and design guidelines. While our plugins work without the PatternFly MCP, connecting your tools to it will provide stronger results. | ||
|
|
||
|
jpuzz0 marked this conversation as resolved.
|
||
| ### Claude Code | ||
|
|
||
| To use our AI Helpers in Claude Code: | ||
|
|
||
| 1. Add the AI Helpers marketplace: | ||
| ```bash | ||
| /plugin marketplace add patternfly/ai-helpers | ||
| ``` | ||
|
|
||
| 2. Install the specific plugins you need: | ||
| ```bash | ||
| /plugin install react@ai-helpers | ||
| ``` | ||
|
jpuzz0 marked this conversation as resolved.
|
||
|
|
||
| 3. Utilize the plugin's skills and knowledge in your project. | ||
|
|
||
| ### Cursor | ||
|
|
||
| Cursor can discover plugins from `.cursor-plugin/` directories. If you also have Claude Code installed, Cursor may pick up installed plugins automatically via its third-party plugin settings. See the [AI Helpers README](https://github.com/patternfly/ai-helpers#cursor) for details. | ||
|
|
||
| ## How can I contribute a plugin? | ||
|
|
||
| The PatternFly AI Helpers marketplace is open source and welcomes contributions from our community. Whether you want to add a new skill to an existing plugin, create an entirely new plugin, or improve the documentation that AI tools rely on, there's a place for your contribution. | ||
|
|
||
| To get started, check out the [contributing guide](https://github.com/patternfly/ai-helpers/blob/main/CONTRIBUTING.md) and the [step-by-step skill creation guide](https://github.com/patternfly/ai-helpers/blob/main/CONTRIBUTING-SKILLS.md). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.