Skip to content

Commit c0b86d3

Browse files
authored
Merge pull request #156 from PMDevSolutions/docs/align-with-implementation
docs: align documentation with actual framework behavior
2 parents dcb6843 + 19111d0 commit c0b86d3

44 files changed

Lines changed: 359 additions & 1088 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.claude/AGENT-NAMING-GUIDE.md‎

Lines changed: 27 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -1,145 +1,56 @@
11
# Agent Naming Guide
22

3-
This guide clarifies naming conflicts and helps you choose the right agent for your task.
3+
This guide helps you choose the right agent when more than one agent shares the same name. Name collisions happen when an installed Claude Code plugin ships an agent whose name matches another plugin's agent — or a local agent in `.claude/agents/`.
44

5-
## Code Reviewer Variants
5+
> **The `plugin/agent` references below are illustrative, not a claim about what is installed.** This template's own agents live in `.claude/agents/`; any additional agents come from whatever plugins you have installed (see `.claude/PLUGINS-REFERENCE.md` for the plugins this project documents). There is **no** local `code-reviewer` agent in this template. Verify what is actually available with `/plugin list` before assuming a specific `plugin/agent` exists.
66
7-
There are **three agents** named "code-reviewer" with different purposes. Use this guide to select the correct one:
7+
## Resolving "code-reviewer" (and similar) collisions
88

9-
### 1. feature-dev/code-reviewer
10-
**When to use:** General code quality review during active development
9+
If you have multiple plugins installed that each provide a similarly-named agent (for example, a `code-reviewer`), prefer the one most specific to your task. The common review situations are:
1110

12-
**Focus:**
13-
- Bug detection
14-
- Security vulnerabilities
15-
- Code smells and anti-patterns
16-
- Best practices compliance
11+
### General development review
12+
For bug detection, security smells, code smells, and best-practice checks during active development. Favor a fast, read-only reviewer.
1713

18-
**Model:** Sonnet (faster reviews)
14+
### Pull-request / merge review
15+
For PR-specific analysis: cross-file impact, integration concerns, and merge readiness before shipping. Favor a comprehensive reviewer that can run tests and check dependencies.
1916

20-
**Tools:** Read-only (Glob, Grep, Read)
17+
### Plan-alignment review
18+
For verifying that an implementation matches an agreed plan or architecture: requirement traceability and completeness. Favor a reviewer that can read both the plan and the diff.
2119

22-
**Confidence:** Reports issues ≥80% confidence
23-
24-
**Example scenarios:**
25-
- "Review this function for bugs"
26-
- "Check if this code is secure"
27-
- "Is this following best practices?"
28-
29-
---
30-
31-
### 2. pr-review-toolkit/code-reviewer
32-
**When to use:** Pull request reviews before merging
33-
34-
**Focus:**
35-
- PR-specific analysis
36-
- Cross-file impact assessment
37-
- Merge readiness
38-
- Integration concerns
39-
40-
**Model:** Opus (comprehensive reviews)
41-
42-
**Tools:** Full access (can run tests, check dependencies)
43-
44-
**Confidence:** Reports issues ≥80% confidence
45-
46-
**Example scenarios:**
47-
- "Review this PR for merge"
48-
- "What's the impact of these changes?"
49-
- "Is this PR ready to ship?"
50-
51-
---
52-
53-
### 3. superpowers/code-reviewer
54-
**When to use:** Verifying implementation matches the plan
55-
56-
**Focus:**
57-
- Plan alignment verification
58-
- Architectural decision validation
59-
- Implementation completeness
60-
- Requirement traceability
61-
62-
**Model:** Inherits from parent (flexible)
63-
64-
**Tools:** Full access
65-
66-
**Example scenarios:**
67-
- "Does this implementation match our plan?"
68-
- "Did we follow the architecture we agreed on?"
69-
- "Are all planned features implemented?"
70-
71-
---
20+
**Quick rule:** match the agent to the moment — general coding vs. PR/merge vs. plan verification — and pick the most specific reviewer your installed plugins provide.
7221

7322
## Quick Decision Tree
7423

7524
```
7625
Need to review code?
7726
│
78-
├─ Is there an implementation plan? ────> superpowers/code-reviewer
27+
├─ Is there an implementation plan? ────> plan-alignment reviewer
7928
│
80-
├─ Is this for a PR/merge? ────────────> pr-review-toolkit/code-reviewer
29+
├─ Is this for a PR/merge? ────────────> PR / merge reviewer
8130
│
82-
└─ General development review ─────────> feature-dev/code-reviewer
31+
└─ General development review ─────────> general-purpose reviewer
8332
```
8433

85-
---
86-
87-
## Code Simplifier Location
88-
89-
**Previously:** Had both standalone `code-simplifier` plugin AND `pr-review-toolkit/code-simplifier` agent (duplicate)
34+
## Other Name Collisions
9035

91-
**Now:** Only `pr-review-toolkit/code-simplifier` remains (standalone plugin removed)
36+
The same "prefer the most specific" principle applies whenever agents overlap:
9237

93-
**When to use:** After code review suggests simplification, invoke this agent to refactor complex code while preserving functionality.
94-
95-
---
38+
### Code simplifiers / refactorers
39+
If more than one refactoring agent is available, use the one intended to run **after** a review — it refactors the flagged code while preserving behavior.
9640

97-
## Other Naming Clarifications
98-
99-
### Test Agents
100-
- **test-writer-fixer** (custom): Writes tests, runs them, fixes failures
101-
- **pr-test-analyzer** (pr-review-toolkit): Analyzes test coverage in PRs
102-
- **Use both:** They're complementary (active vs. passive testing)
103-
104-
### Frontend Agents
105-
- **frontend-developer** (custom): Full-stack frontend implementation
106-
- **frontend-design** (plugin): UI/UX design and prototyping
107-
- **Use both:** Design first, then implement
108-
109-
---
41+
### Test agents
42+
This template ships a local **test-writer-fixer** (writes tests, runs them, fixes failures). If a plugin also provides a test-coverage analyzer, treat them as complementary: active fixing vs. passive analysis.
11043

111-
## WordPress FSE Development Stack
112-
113-
For WordPress block theme development, your core agents are:
114-
115-
**Code Quality:**
116-
- feature-dev/code-reviewer (development reviews)
117-
- pr-review-toolkit/code-reviewer (PR reviews)
118-
119-
**Development:**
120-
- frontend-developer (JS/CSS implementation)
121-
- test-writer-fixer (PHP unit tests)
122-
123-
**Performance:**
124-
- performance-benchmarker (optimization)
125-
126-
**Design:**
127-
- ui-designer (block patterns, theme design)
128-
- ux-researcher (usability testing)
129-
130-
**Infrastructure:**
131-
- php-lsp (code intelligence)
132-
- security-guidance (WordPress security)
133-
134-
---
44+
### Frontend agents
45+
This template ships a local **frontend-developer** (full-stack FSE implementation). If a plugin also provides a UI/UX design agent, design first, then implement.
13546

13647
## When in Doubt
13748

138-
If you're unsure which agent to use:
139-
1. Check this guide's decision tree
140-
2. Use the more specific agent (e.g., pr-review-toolkit for PRs)
141-
3. Ask Claude Code: "Which code-reviewer should I use for [task]?"
49+
1. Run `/plugin list` to see which plugins — and therefore which plugin agents — are actually installed.
50+
2. Check the decision tree above.
51+
3. Prefer the more specific agent for your task (e.g., a PR reviewer for PRs).
52+
4. Ask Claude Code: "Which agent should I use for [task]?"
14253

14354
---
14455

145-
**Last Updated:** 2026-01-18
56+
**Last Updated:** 2026-06-28

‎.claude/CUSTOM-AGENTS-GUIDE.md‎

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,24 @@ These agents directly support WordPress block theme development:
100100
- **WordPress relevance:** Critical - turns the scaffold into an e-commerce-ready store
101101
- **Backed by:** `themes/flavian-shop/` and `scripts/wordpress-install/setup-woocommerce.sh`
102102

103+
### **headless-developer** (NEW)
104+
- **Purpose:** Headless WordPress setup and decoupled-frontend integration
105+
- **Use for:** Installing/configuring WPGraphQL, wiring CORS and preview links via the `flavian-headless` mu-plugin, scaffolding Next.js frontends, troubleshooting GraphQL/REST endpoints
106+
- **WordPress relevance:** High - turns the scaffold into a headless content API for decoupled frontends
107+
- **Backed by:** `scripts/wordpress-install/setup-headless.sh` and `scripts/scaffold-frontend.sh`
108+
109+
### **figma-fse-converter** (NEW)
110+
- **Purpose:** Autonomous Figma-to-WordPress FSE theme conversion
111+
- **Use for:** Extracting design systems from Figma, generating theme.json, creating pixel-perfect FSE templates with WordPress blocks
112+
- **WordPress relevance:** Critical - primary engine of the Figma-to-FSE conversion pipeline
113+
- **Backed by:** `scripts/figma-fse/` and the `figma-to-fse-autonomous-workflow` skill
114+
115+
### **canva-fse-converter** (NEW)
116+
- **Purpose:** Convert Canva HTML/CSS exports into WordPress FSE block themes
117+
- **Use for:** Parsing design tokens from Canva CSS, converting HTML elements to WordPress blocks, generating theme.json and templates
118+
- **WordPress relevance:** Critical - alternate design-source entry point to the FSE pipeline
119+
- **Backed by:** `scripts/canva-fse/` and the `canva-to-fse-autonomous-workflow` skill
120+
103121
### **indesign-to-wordpress** (NEW)
104122
- **Purpose:** Convert an Adobe InDesign document (`.idml` or PDF) into a WordPress FSE block theme
105123
- **Use for:** Orchestrating the `@flavian/pipeline` InDesign stages (parse → map design tokens → generate patterns/templates/parts/theme.json), reviewing the generation report, and proposing concrete follow-ups (unmapped frames, font fallbacks, alt text). Non-destructive — works on a feature branch, never on `main`
@@ -140,7 +158,7 @@ These agents can be useful but aren't WordPress-specific:
140158

141159
---
142160

143-
## Generic/Cross-Domain Agents (25 total)
161+
## Generic/Cross-Domain Agents (27 total)
144162

145163
These agents are domain-agnostic and useful across all project types. Backported from the Coding Framework project.
146164

@@ -212,7 +230,7 @@ User: "Use the frontend-developer agent to help me build this block pattern"
212230

213231
## How Agents Work with WordPress Skills
214232

215-
**NEW:** This template includes 8 custom WordPress development skills that complement the agents.
233+
**NEW:** This template includes 12 custom WordPress development skills that complement the agents.
216234

217235
### Skills vs Agents
218236

@@ -242,9 +260,9 @@ User: "Use the frontend-developer agent to help me build this block pattern"
242260
### Complete WordPress Development Stack
243261

244262
```
245-
WordPress Skills (8)
263+
WordPress Skills (12)
246264
↓ Provide workflows and best practices
247-
Agents (45)
265+
Agents (53)
248266
↓ Execute specialized tasks
249267
Plugins (6)
250268
↓ Provide tooling and memory
@@ -259,7 +277,7 @@ Automation Scripts (4)
259277
## Current Architecture Status
260278

261279
**Plugins:** ✅ Already optimized (5 user + 1 local)
262-
**Custom Agents:** 45 total (20 WordPress-focused + 25 generic cross-domain)
280+
**Custom Agents:** 53 total (26 WordPress-focused + 27 generic cross-domain)
263281

264282
---
265283

@@ -328,7 +346,7 @@ Ready for release
328346

329347
## Agent Hook Configurations
330348

331-
Agents with automated hooks (17 of 20):
349+
Agents with automated hooks (18 of the 26 WordPress-focused agents):
332350

333351
### WordPress Core Quality Hooks (shared scripts)
334352
These scripts are shared across multiple agents:
@@ -351,12 +369,12 @@ These scripts are shared across multiple agents:
351369
| seo-schema-agent | PostToolUse | validate-block-markup.sh | Block markup and heading hierarchy |
352370
| asset-cataloger | PreToolUse | validate-theme-location.sh | Blocks wp-content/ writes |
353371

354-
### Agents Without Hooks (3)
372+
### Research/Audit-Only Agents (no hooks needed)
355373
These agents are research/audit-only and don't need automated hooks:
356374
- accessibility-auditor (runs Lighthouse on demand)
357375
- visual-qa-agent (captures screenshots on demand)
358376
- ux-researcher (research only)
359377

360378
---
361379

362-
**Architecture Assessment:** 49 custom agents provide comprehensive development coverage — 24 WordPress-specific agents for visual QA, asset management, environment management, markup validation, accessibility, token compliance, content seeding, and SEO, plus 25 generic cross-domain agents for business, marketing, engineering, and meta/ops tasks.
380+
**Architecture Assessment:** 53 custom agents provide comprehensive development coverage — 26 WordPress-focused agents for design-source conversion (Figma/Canva/InDesign), visual QA, asset management, environment management, markup validation, accessibility, token compliance, content seeding, SEO, security, deployment, e-commerce, and headless integration, plus 27 generic cross-domain agents for business, marketing, engineering, and meta/ops tasks.

‎.claude/PLUGINS-REFERENCE.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,7 @@ If you see agents named "code-reviewer" from different plugins, refer to `.claud
489489
## 🎯 WordPress Development Skills (NEW)
490490

491491
**Installed:** 2026-01-18
492-
**Total Skills:** 8 comprehensive WordPress workflows
492+
**Total Skills:** 12 comprehensive WordPress workflows
493493

494494
This template includes custom WordPress development skills that complement the plugins and agents.
495495

@@ -550,6 +550,10 @@ This template includes custom WordPress development skills that complement the p
550550
- WP-CLI automation with safe workflows and backups
551551
- Triggers: "scaffold theme", "wp command", "database export"
552552

553+
12. **indesign-conversion**
554+
- Orchestrator for converting Adobe InDesign documents (`.idml` or PDF) to FSE block themes
555+
- Triggers: "InDesign to WordPress", "IDML", "convert InDesign", "print to web"
556+
553557
### Skills vs Plugins
554558

555559
| Type | Purpose | Invocation | Example |
@@ -587,4 +591,4 @@ wordpress-testing-workflows skill guides:
587591
**Last Updated:** 2026-01-18
588592
**Template Version:** 1.0.0
589593
**Architecture Status:** ✅ Optimized and Windows-compatible
590-
**WordPress Skills:** ✅ 8 comprehensive workflows installed
594+
**WordPress Skills:** ✅ 12 comprehensive workflows installed

‎.claude/SETUP-COMPLETE.md‎

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Claude Code Plugins Setup - Complete ✅
22

33
**Setup Date:** 2026-01-18
4+
**Last Reviewed:** 2026-06-28 — reflects current config (6 plugins, 53 agents, 12 skills, 4 commands)
45
**Status:** All plugins installed and configured
56

67
---
78

8-
## ✅ Installed Plugins
9+
## ✅ Installed Plugins (6 Total)
910

1011
### 1. php-lsp (PHP Language Server)
1112
- **Status:** Installed
@@ -25,6 +26,24 @@
2526
- **Prerequisite:** Git configured
2627
- **Next Step:** Test with `/commit` command
2728

29+
### 4. episodic-memory (Conversation Memory)
30+
- **Status:** Installed
31+
- **Purpose:** Conversation search and recall across sessions
32+
- **Prerequisite:** None
33+
- **Next Step:** Search prior conversations as you work
34+
35+
### 5. superpowers (Advanced Workflows)
36+
- **Status:** Installed
37+
- **Purpose:** Advanced development workflows and tooling
38+
- **Prerequisite:** None
39+
- **Next Step:** Invoke superpowers workflows as needed
40+
41+
### 6. ai-taskmaster (Task Management — local)
42+
- **Status:** Installed
43+
- **Purpose:** Task management and planning
44+
- **Prerequisite:** None
45+
- **Next Step:** Track tasks for your project
46+
2847
---
2948

3049
## 🔧 Permission Updates
@@ -88,7 +107,7 @@ which intelephense
88107
```
89108

90109
**2. Test Autocomplete in WordPress File**
91-
- Open: `wp-content/themes/*/functions.php` (or create test file)
110+
- Open: `themes/*/functions.php` (or create test file)
92111
- Type: `wp_enqueue_`
93112
- **Expected:** Autocomplete suggestions appear with WordPress functions
94113
- **Expected:** Hover shows function documentation
@@ -168,9 +187,12 @@ git add .
168187
**Expected Output:**
169188
```
170189
Installed plugins:
171-
- php-lsp
172-
- github
190+
- episodic-memory
173191
- commit-commands
192+
- github
193+
- php-lsp
194+
- superpowers
195+
- ai-taskmaster
174196
```
175197

176198
---
@@ -243,7 +265,7 @@ See `.claude/PLUGINS-REFERENCE.md` > "WordPress FSE Development Workflows"
243265

244266
### WordPress Development Setup
245267
1. Install WordPress locally (if not already)
246-
2. Create or clone FSE theme in `wp-content/themes/`
268+
2. Create or clone FSE theme in `themes/` (root-level — never `wp-content/themes/` during development)
247269
3. Test PHP LSP in theme files
248270
4. Set up GitHub repository for theme
249271
5. Configure development workflow with new plugins
@@ -253,7 +275,7 @@ See `.claude/PLUGINS-REFERENCE.md` > "WordPress FSE Development Workflows"
253275
# 1. Start new feature
254276
git checkout -b feature/new-block-pattern
255277

256-
# 2. Develop in wp-content/themes/your-theme/
278+
# 2. Develop in themes/your-theme/
257279
# - PHP LSP provides autocomplete
258280
# - Real-time error detection
259281

@@ -278,8 +300,8 @@ git pull
278300
- [x] GitHub integration installed
279301
- [x] Git workflows automated
280302
- [x] WordPress CLI available
281-
- [x] Custom agents configured (49 agents)
282-
- [x] Custom commands available (test, lint, create-blog-article)
303+
- [x] Custom agents configured (53 agents)
304+
- [x] Custom commands available (create-blog-article, lint, test, scaffold-block)
283305
- [x] Permissions properly scoped
284306

285307
### ⏭️ To Configure
@@ -319,4 +341,4 @@ Your environment is now optimized for:
319341

320342
**Setup completed successfully! Ready for WordPress FSE development.**
321343

322-
*Last updated: 2026-01-18*
344+
*Last updated: 2026-06-28*

0 commit comments

Comments
 (0)