Skip to content

Commit 3c729b3

Browse files
kieranklaassenkieranklaassen
authored
Merge pull request #21 from EveryInc/claude/add-devtool-docs-01VWyrYPfQr5o2zAtZzYXhvu
Add DevTool template documentation to repo
2 parents 531cfe7 + f63dab9 commit 3c729b3

19 files changed

Lines changed: 8486 additions & 59 deletions

File tree

‎.claude-plugin/marketplace.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
"plugins": [
1212
{
1313
"name": "compounding-engineering",
14-
"description": "AI-powered development tools that get smarter with every use. Make each unit of engineering work easier than the last. Includes 17 specialized agents, 6 commands, and 1 skill.",
15-
"version": "1.1.0",
14+
"description": "AI-powered development tools that get smarter with every use. Make each unit of engineering work easier than the last. Includes 23 specialized agents, 16 commands, and 11 skills.",
15+
"version": "2.6.0",
1616
"author": {
1717
"name": "Kieran Klaassen",
1818
"url": "https://github.com/kieranklaassen",

‎.github/workflows/deploy-docs.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Deploy Documentation to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'plugins/compounding-engineering/docs/**'
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: "pages"
17+
cancel-in-progress: false
18+
19+
jobs:
20+
deploy:
21+
environment:
22+
name: github-pages
23+
url: ${{ steps.deployment.outputs.page_url }}
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v4
28+
29+
- name: Setup Pages
30+
uses: actions/configure-pages@v4
31+
32+
- name: Upload artifact
33+
uses: actions/upload-pages-artifact@v3
34+
with:
35+
path: 'plugins/compounding-engineering/docs'
36+
37+
- name: Deploy to GitHub Pages
38+
id: deployment
39+
uses: actions/deploy-pages@v4

‎CLAUDE.md‎

Lines changed: 91 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,15 @@ every-marketplace/
1212
└── compounding-engineering/ # The actual plugin
1313
├── .claude-plugin/
1414
│ └── plugin.json # Plugin metadata
15-
├── agents/ # 17 specialized AI agents
16-
├── commands/ # 6 slash commands
17-
├── skills/ # 1 skill (gemini-imagegen)
15+
├── agents/ # 24 specialized AI agents
16+
├── commands/ # 13 slash commands (including /release-docs)
17+
├── skills/ # 11 skills
18+
├── mcp-servers/ # 2 MCP servers (playwright, context7)
19+
├── docs/ # Documentation site (static HTML/CSS/JS)
20+
│ ├── index.html # Landing page
21+
│ ├── css/ # Stylesheets (style.css, docs.css)
22+
│ ├── js/ # JavaScript (main.js)
23+
│ └── pages/ # Reference pages (agents, commands, skills, mcp-servers)
1824
├── README.md # Plugin documentation
1925
└── CHANGELOG.md # Version history
2026
```
@@ -86,7 +92,21 @@ When adding new functionality, bump the version in:
8692
- [ ] `plugins/compounding-engineering/CHANGELOG.md` → document changes
8793
- [ ] `CLAUDE.md` → update structure diagram if needed
8894

89-
#### 5. Validate JSON files
95+
#### 5. Rebuild documentation site
96+
97+
Run the release-docs command to update all documentation pages:
98+
99+
```bash
100+
claude /release-docs
101+
```
102+
103+
This will:
104+
- Update stats on the landing page
105+
- Regenerate reference pages (agents, commands, skills, MCP servers)
106+
- Update the changelog page
107+
- Validate all counts match actual files
108+
109+
#### 6. Validate JSON files
90110

91111
```bash
92112
cat .claude-plugin/marketplace.json | jq .
@@ -167,6 +187,73 @@ Each plugin has its own plugin.json with detailed metadata:
167187
}
168188
```
169189

190+
## Documentation Site
191+
192+
The plugin includes a static documentation site at `plugins/compounding-engineering/docs/`. This site is built with plain HTML/CSS/JS (based on Evil Martians' LaunchKit template) and requires no build step to view.
193+
194+
### Documentation Structure
195+
196+
```
197+
docs/
198+
├── index.html # Landing page with stats and philosophy
199+
├── css/
200+
│ ├── style.css # Main styles (LaunchKit-based)
201+
│ └── docs.css # Documentation-specific styles
202+
├── js/
203+
│ └── main.js # Interactivity (theme toggle, mobile nav)
204+
└── pages/
205+
├── getting-started.html # Installation and quick start
206+
├── agents.html # All 24 agents reference
207+
├── commands.html # All 13 commands reference
208+
├── skills.html # All 11 skills reference
209+
├── mcp-servers.html # MCP servers reference
210+
└── changelog.html # Version history
211+
```
212+
213+
### Keeping Docs Up-to-Date
214+
215+
**IMPORTANT:** After ANY change to agents, commands, skills, or MCP servers, run:
216+
217+
```bash
218+
claude /release-docs
219+
```
220+
221+
This command:
222+
1. Counts all current components
223+
2. Reads all agent/command/skill/MCP files
224+
3. Regenerates all reference pages
225+
4. Updates stats on the landing page
226+
5. Updates the changelog from CHANGELOG.md
227+
6. Validates counts match across all files
228+
229+
### Manual Updates
230+
231+
If you need to update docs manually:
232+
233+
1. **Landing page stats** - Update the numbers in `docs/index.html`:
234+
```html
235+
<span class="stat-number">24</span> <!-- agents -->
236+
<span class="stat-number">13</span> <!-- commands -->
237+
```
238+
239+
2. **Reference pages** - Each page in `docs/pages/` documents all components in that category
240+
241+
3. **Changelog** - `docs/pages/changelog.html` mirrors `CHANGELOG.md` in HTML format
242+
243+
### Viewing Docs Locally
244+
245+
Since the docs are static HTML, you can view them directly:
246+
247+
```bash
248+
# Open in browser
249+
open plugins/compounding-engineering/docs/index.html
250+
251+
# Or start a local server
252+
cd plugins/compounding-engineering/docs
253+
python -m http.server 8000
254+
# Then visit http://localhost:8000
255+
```
256+
170257
## Testing Changes
171258

172259
### Test Locally

‎plugins/compounding-engineering/.claude-plugin/plugin.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "compounding-engineering",
3-
"version": "2.5.0",
4-
"description": "AI-powered development tools. 24 agents, 16 commands, 11 skills, 2 MCP servers for code review, research, design, and workflow automation.",
3+
"version": "2.6.0",
4+
"description": "AI-powered development tools. 23 agents, 16 commands, 11 skills, 2 MCP servers for code review, research, design, and workflow automation.",
55
"author": {
66
"name": "Kieran Klaassen",
77
"email": "kieran@every.to",

‎plugins/compounding-engineering/CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ All notable changes to the compounding-engineering plugin will be documented in
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [2.6.0] - 2024-11-26
9+
10+
### Removed
11+
12+
- **`feedback-codifier` agent** - Removed from workflow agents. Agent count reduced from 24 to 23.
13+
814
## [2.5.0] - 2024-11-25
915

1016
### Added

‎plugins/compounding-engineering/README.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ AI-powered development tools that get smarter with every use. Make each unit of
66

77
| Component | Count |
88
|-----------|-------|
9-
| Agents | 24 |
9+
| Agents | 23 |
1010
| Commands | 16 |
1111
| Skills | 11 |
1212
| MCP Servers | 2 |
@@ -47,13 +47,12 @@ Agents are organized into categories for easier discovery.
4747
| `design-iterator` | Iteratively refine UI through systematic design iterations |
4848
| `figma-design-sync` | Synchronize web implementations with Figma designs |
4949

50-
### Workflow (6)
50+
### Workflow (5)
5151

5252
| Agent | Description |
5353
|-------|-------------|
5454
| `bug-reproduction-validator` | Systematically reproduce and validate bug reports |
5555
| `every-style-editor` | Edit content to conform to Every's style guide |
56-
| `feedback-codifier` | Codify feedback patterns into reviewer agents |
5756
| `lint` | Run linting and code quality checks on Ruby and ERB files |
5857
| `pr-comment-resolver` | Address PR comments and implement fixes |
5958
| `spec-flow-analyzer` | Analyze user flows and identify gaps in specifications |

‎plugins/compounding-engineering/agents/workflow/feedback-codifier.md‎

Lines changed: 0 additions & 48 deletions
This file was deleted.

‎plugins/compounding-engineering/commands/deploy-docs.md‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
name: deploy-docs
3+
description: Validate and prepare documentation for GitHub Pages deployment
4+
---
5+
6+
# Deploy Documentation Command
7+
8+
Validate the documentation site and prepare it for GitHub Pages deployment.
9+
10+
## Step 1: Validate Documentation
11+
12+
Run these checks:
13+
14+
```bash
15+
# Count components
16+
echo "Agents: $(ls plugins/compounding-engineering/agents/*.md | wc -l)"
17+
echo "Commands: $(ls plugins/compounding-engineering/commands/*.md | wc -l)"
18+
echo "Skills: $(ls -d plugins/compounding-engineering/skills/*/ 2>/dev/null | wc -l)"
19+
20+
# Validate JSON
21+
cat .claude-plugin/marketplace.json | jq . > /dev/null && echo "✓ marketplace.json valid"
22+
cat plugins/compounding-engineering/.claude-plugin/plugin.json | jq . > /dev/null && echo "✓ plugin.json valid"
23+
24+
# Check all HTML files exist
25+
for page in index agents commands skills mcp-servers changelog getting-started; do
26+
if [ -f "plugins/compounding-engineering/docs/pages/${page}.html" ] || [ -f "plugins/compounding-engineering/docs/${page}.html" ]; then
27+
echo "✓ ${page}.html exists"
28+
else
29+
echo "✗ ${page}.html MISSING"
30+
fi
31+
done
32+
```
33+
34+
## Step 2: Check for Uncommitted Changes
35+
36+
```bash
37+
git status --porcelain plugins/compounding-engineering/docs/
38+
```
39+
40+
If there are uncommitted changes, warn the user to commit first.
41+
42+
## Step 3: Deployment Instructions
43+
44+
Since GitHub Pages deployment requires a workflow file with special permissions, provide these instructions:
45+
46+
### First-time Setup
47+
48+
1. Create `.github/workflows/deploy-docs.yml` with the GitHub Pages workflow
49+
2. Go to repository Settings > Pages
50+
3. Set Source to "GitHub Actions"
51+
52+
### Deploying
53+
54+
After merging to `main`, the docs will auto-deploy. Or:
55+
56+
1. Go to Actions tab
57+
2. Select "Deploy Documentation to GitHub Pages"
58+
3. Click "Run workflow"
59+
60+
### Workflow File Content
61+
62+
```yaml
63+
name: Deploy Documentation to GitHub Pages
64+
65+
on:
66+
push:
67+
branches: [main]
68+
paths:
69+
- 'plugins/compounding-engineering/docs/**'
70+
workflow_dispatch:
71+
72+
permissions:
73+
contents: read
74+
pages: write
75+
id-token: write
76+
77+
concurrency:
78+
group: "pages"
79+
cancel-in-progress: false
80+
81+
jobs:
82+
deploy:
83+
environment:
84+
name: github-pages
85+
url: ${{ steps.deployment.outputs.page_url }}
86+
runs-on: ubuntu-latest
87+
steps:
88+
- uses: actions/checkout@v4
89+
- uses: actions/configure-pages@v4
90+
- uses: actions/upload-pages-artifact@v3
91+
with:
92+
path: 'plugins/compounding-engineering/docs'
93+
- uses: actions/deploy-pages@v4
94+
```
95+
96+
## Step 4: Report Status
97+
98+
Provide a summary:
99+
100+
```
101+
## Deployment Readiness
102+
103+
✓ All HTML pages present
104+
✓ JSON files valid
105+
✓ Component counts match
106+
107+
### Next Steps
108+
- [ ] Commit any pending changes
109+
- [ ] Push to main branch
110+
- [ ] Verify GitHub Pages workflow exists
111+
- [ ] Check deployment at https://everyinc.github.io/every-marketplace/
112+
```

0 commit comments

Comments
 (0)