docs(AI): add AI development tools page and replace stale references#4991
docs(AI): add AI development tools page and replace stale references#4991jpuzz0 wants to merge 1 commit intopatternfly:mainfrom
Conversation
nicolethoen
left a comment
There was a problem hiding this comment.
Overall I think this is a great update. I'll leave editing of the microcopy to @edonehoo
| @@ -0,0 +1,59 @@ | |||
| --- | |||
| id: AI development tools | |||
There was a problem hiding this comment.
I would be curious on @edonehoo's thoughts on the title of this page - Is 'Plugins' more descriptive?
There was a problem hiding this comment.
I like Plugins -- I think it's more generally aligned since (I assume) we expect more than just devs to use the plugins we're creating
edonehoo
left a comment
There was a problem hiding this comment.
a bunch of comments 🫣 but lmk what you think
| @@ -0,0 +1,59 @@ | |||
| --- | |||
| id: AI development tools | |||
There was a problem hiding this comment.
I like Plugins -- I think it's more generally aligned since (I assume) we expect more than just devs to use the plugins we're creating
| 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 development knowledge and skills tailored to PatternFly workflows, so your AI tools generate more accurate, best-practice code out of the box. |
There was a problem hiding this comment.
| 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 development knowledge and skills tailored to PatternFly workflows, so your AI tools generate more accurate, best-practice code out of the box. | |
| 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. |
you may want to keep this as "generate more accurate code" in the final sentence -- I was thinking that some of our plugins aren't directly tied to code all the time
|
|
||
| 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 development knowledge and skills tailored to PatternFly workflows, so your AI tools generate more accurate, best-practice code out of the box. | ||
|
|
||
| Whether you're building PatternFly UIs, prototyping in code, or evaluating AI tooling for your team, AI helpers can help. |
There was a problem hiding this comment.
| Whether you're building PatternFly UIs, prototyping in code, or evaluating AI tooling for your team, AI helpers can help. | |
| 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. |
this is a curiosity nit - but what would be the difference between building PatternFly UIs vs prototyping in code? Like Red Hat products vs random experimental prototypes?
| @@ -0,0 +1,59 @@ | |||
| --- | |||
| id: AI development tools | |||
| 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 development knowledge and skills tailored to PatternFly workflows, so your AI tools generate more accurate, best-practice code out of the box. |
There was a problem hiding this comment.
would you want to "brand" this as "AI Helpers" capitalized as a proper noun? Or do you like it how it is? It might make things easier to read if it's a proper noun, but I'll leave it to you
|
|
||
| If you need to add AI tools to existing codebases instead, follow our guidelines for [enhancing existing projects](/ai/rapid-prototyping/enhancing-existing-projects). | ||
|
|
||
| ## Project setup |
There was a problem hiding this comment.
| ## Get started |
| 2. Install dependencies according to [the project's README](https://github.com/patternfly/patternfly-react-seed/tree/ai_enabled?tab=readme-ov-file#patternfly-seed). | ||
| 3. Start the development server. | ||
| 4. Begin prototyping with your AI development tools. | ||
| 3. Install [AI helpers](https://github.com/patternfly/ai-helpers) marketplace plugins to give your AI tools additional context and skills for PatternFly development. See the [AI development tools](/ai/ai-development-tools) page for setup instructions. |
There was a problem hiding this comment.
| 3. Install [AI helpers](https://github.com/patternfly/ai-helpers) marketplace plugins to give your AI tools additional context and skills for PatternFly development. See the [AI development tools](/ai/ai-development-tools) page for setup instructions. | |
| 3. To give your AI tools additional context and skills for PatternFly development, install plugins from our [AI helpers](https://github.com/patternfly/ai-helpers) marketplace. For instructions on getting started, refer to our [AI development tools](/ai/ai-development-tools) guidance. |
another note to double check the link before merging
| 4. Start the development server. | ||
| 5. Begin prototyping with your AI development tools. | ||
|
|
||
| ## How to prototype |
There was a problem hiding this comment.
| ## How to prototype | |
| ## How do I prototype? |
| ## How to prototype | ||
|
|
||
| Once you've installed and set up the patternfly-react-seed ai_enabled branch, with the [patternfly-ai-coding tool](https://github.com/patternfly/patternfly-ai-coding), follow these steps to begin prototyping: | ||
| Once you've set up the patternfly-react-seed and installed the AI helpers plugins, follow these steps to begin prototyping: |
There was a problem hiding this comment.
| Once you've set up the patternfly-react-seed and installed the AI helpers plugins, follow these steps to begin prototyping: | |
| Once you've set up the patternfly-react-seed and installed the PatternFly AI helpers plugins, follow these steps to begin prototyping: |
| - **[Design language](/ai/design-language):** The foundational design decisions that guide the use of AI features in products. | ||
| - **[Design language](/ai/design-language):** The foundational design decisions that guide the use of AI features in products. | ||
| - **[Rapid prototyping](/ai/rapid-prototyping):** Guidance for generating and iterating AI features during early stages of design. | ||
| - **[AI development tools](/ai/ai-development-tools):** Tools and plugins that help AI coding assistants generate more accurate, PatternFly-compliant code. |
There was a problem hiding this comment.
| - **[AI development tools](/ai/ai-development-tools):** Tools and plugins that help AI coding assistants generate more accurate, PatternFly-compliant code. | |
| - **[AI development tools](/ai/ai-development-tools):** Knowledge and skills that help AI coding assistants generate more accurate, PatternFly-compliant code. |
Summary
Resolves patternfly/ai-helpers#55