You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat(skills): add PatternFly 6 development skill for Claude Code
Introduce a comprehensive Claude Code skill that provides AI-assisted
PatternFly 6 development guidance. The skill auto-activates when working
with @patternfly imports, PF6 components, charts, chatbot, or
component-groups.
New files:
- SKILL.md: Main skill definition with import patterns, styling rules,
and accessibility guidance
- IMPORTS.md: Complete import patterns for all PatternFly packages
- STYLING.md: CSS classes and design token reference
- TROUBLESHOOTING.md: Common issues and solutions
- README.md: Installation and usage documentation
- Validation scripts for import patterns and legacy class detection
- Documentation fetching script for live updates from GitHub
Also adds AGENTS.md and CLAUDE.md for AI agent guidance and updates
the main README with Claude Code skill installation instructions.
---
Signed-off-by: Guillaume Moutier <guimou@users.noreply.github.com>
Co-authored-by: Claude
This file provides guidance to AI agents when working with code in this repository.
4
+
5
+
## Repository Purpose
6
+
7
+
This is a **documentation and AI knowledge base repository** for PatternFly development. It provides indexed documentation, guidelines, and best practices that AI coding tools (Cursor, Copilot, ChatGPT, Claude) can use to generate accurate PatternFly code.
8
+
9
+
**This repository contains no runnable code** - it consists of markdown documentation files that should be copied into target projects.
10
+
11
+
## Documentation Structure
12
+
13
+
-`.pf-ai-documentation/` - Main documentation directory
14
+
-`README.md` - Table of contents and navigation hub
15
+
-`setup/` - Project initialization and environment setup
16
+
-`guidelines/` - Core development principles and standards
17
+
-`components/` - Component-specific rules (layout, data display)
Copy file name to clipboardExpand all lines: README.md
+47-2Lines changed: 47 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,44 +1,87 @@
1
1
# PatternFly AI Coding Support
2
2
3
3
## Who is this for?
4
+
4
5
This repository is for individuals and AI agents who want to prototype PatternFly applications using the latest best practices, with AI assistance (Cursor, Copilot, ChatGPT, etc.).
5
6
6
7
## Quick Start (TL;DR)
8
+
7
9
1.**Clone or copy this repo (or at least the `.pf-ai-documentation/` directory and `.cursor/rules/` files) into your project.**
8
10
2.**Open your project in Cursor or your preferred AI coding tool.**
9
11
3. (Optional) **Set up context7 MCP for always-up-to-date PatternFly docs.**
10
12
11
13
## Goal
14
+
12
15
The primary aim is to offer a comprehensive, AI-friendly knowledge base and starting point for prototyping PatternFly applications. By indexing relevant documentation and providing context files, this repo ensures that any AI model can deliver accurate, consistent, and best-practice guidance while you code.
13
16
14
17
## Core Components
18
+
15
19
The core components of this repository are the README and markdown files found throughout the project. These files provide indexed documentation, guidelines, and best practices to support AI-assisted PatternFly development, regardless of which AI coding tool you use.
16
20
17
-
-**Table of Contents:** See [`.pf-ai-documentation/README.md`](documentation/README.md) for a full table of contents and navigation to all rules, guides, and best practices.
21
+
-**Table of Contents:** See [`.pf-ai-documentation/README.md`](.pf-ai-documentation/README.md) for a full table of contents and navigation to all rules, guides, and best practices.
22
+
23
+
## Claude Code Skill
24
+
25
+
For [Claude Code](https://claude.ai/code) users, this repository includes a ready-to-use skill that provides PatternFly 6 development guidance directly in your coding sessions.
git commit -m "Add PatternFly 6 development skill"
43
+
```
44
+
45
+
### Features
46
+
47
+
-**Automatic activation** when working with PatternFly components
48
+
-**Import pattern guidance** for charts, chatbot, and component-groups
49
+
-**CSS and styling rules** with design token reference
50
+
-**Validation scripts** to check for common issues
51
+
-**Live documentation** fetched from this repository
52
+
53
+
See [`skills/patternfly-6-development/README.md`](skills/patternfly-6-development/README.md) for full documentation.
18
54
19
55
## Using This Documentation with Cursor and AI Tools
20
56
21
57
> **Important:**
22
58
> Simply providing a link to this repository is not enough for Cursor (or most AI tools) to load all the context and instructions. These tools only index files that are present in your local project workspace.
23
59
24
60
### Best Practice: Add Documentation Locally
61
+
25
62
To get the full benefit of these docs and rules:
63
+
26
64
1.**Clone or copy this repository (or at least the `.pf-ai-documentation/` directory and `.cursor/rules/` files) into your project.**
27
65
2.**Open your project in Cursor (or your preferred AI coding tool).**
28
66
3.**Keep your local docs up to date** by pulling changes from this repo as it evolves.
29
67
30
68
### Why Local Files Matter
69
+
31
70
- Cursor and similar tools only use files present in your local workspace for context and code search.
32
71
- If the documentation and rules are not present locally, the AI will not "see" them, even if you provide a link.
33
72
34
73
### For Maximum Effectiveness
74
+
35
75
- Use context7 or another MCP server to supplement your local docs with the latest upstream PatternFly documentation.
36
76
- Encourage your team to read and follow the local documentation and rules for consistent, best-practice PatternFly development.
37
77
38
78
## Setting Up context7 MCP for Latest Docs (Optional)
79
+
>
39
80
> **How to set up context7 MCP server:**
81
+
>
40
82
> 1. Ensure you have Node.js v18+ and an MCP-compatible client (e.g., Cursor, VS Code with MCP extension, Windsurf, Claude Desktop).
41
83
> 2. Add context7 as an MCP server in your client's configuration. For example, in Cursor, add this to your `~/.cursor/mcp.json`:
84
+
>
42
85
> ```json
43
86
> {
44
87
> "mcpServers": {
@@ -49,10 +92,12 @@ To get the full benefit of these docs and rules:
49
92
> }
50
93
> }
51
94
> ```
95
+
>
52
96
> 3. Save and restart your client/editor.
53
-
> 4. For more details and setup instructions for other editors, see the official guide: https://github.com/upstash/context7#installation
97
+
> 4. For more details and setup instructions for other editors, see the official guide: <https://github.com/upstash/context7#installation>
0 commit comments