Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .claude-plugin/marketplace.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
"plugins": [
{
"name": "compounding-engineering",
"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.",
"version": "1.1.0",
"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.",
"version": "2.6.0",
"author": {
"name": "Kieran Klaassen",
"url": "https://github.com/kieranklaassen",
Expand Down
39 changes: 39 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Deploy Documentation to GitHub Pages

on:
push:
branches: [main]
paths:
- 'plugins/compounding-engineering/docs/**'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Pages
uses: actions/configure-pages@v4

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'plugins/compounding-engineering/docs'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
95 changes: 91 additions & 4 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,15 @@ every-marketplace/
└── compounding-engineering/ # The actual plugin
├── .claude-plugin/
│ └── plugin.json # Plugin metadata
├── agents/ # 17 specialized AI agents
├── commands/ # 6 slash commands
├── skills/ # 1 skill (gemini-imagegen)
├── agents/ # 24 specialized AI agents
├── commands/ # 13 slash commands (including /release-docs)
├── skills/ # 11 skills
├── mcp-servers/ # 2 MCP servers (playwright, context7)
├── docs/ # Documentation site (static HTML/CSS/JS)
│ ├── index.html # Landing page
│ ├── css/ # Stylesheets (style.css, docs.css)
│ ├── js/ # JavaScript (main.js)
│ └── pages/ # Reference pages (agents, commands, skills, mcp-servers)
├── README.md # Plugin documentation
└── CHANGELOG.md # Version history
```
Expand Down Expand Up @@ -86,7 +92,21 @@ When adding new functionality, bump the version in:
- [ ] `plugins/compounding-engineering/CHANGELOG.md` → document changes
- [ ] `CLAUDE.md` → update structure diagram if needed

#### 5. Validate JSON files
#### 5. Rebuild documentation site

Run the release-docs command to update all documentation pages:

```bash
claude /release-docs
```

This will:
- Update stats on the landing page
- Regenerate reference pages (agents, commands, skills, MCP servers)
- Update the changelog page
- Validate all counts match actual files

#### 6. Validate JSON files

```bash
cat .claude-plugin/marketplace.json | jq .
Expand Down Expand Up @@ -167,6 +187,73 @@ Each plugin has its own plugin.json with detailed metadata:
}
```

## Documentation Site

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.

### Documentation Structure

```
docs/
├── index.html # Landing page with stats and philosophy
├── css/
│ ├── style.css # Main styles (LaunchKit-based)
│ └── docs.css # Documentation-specific styles
├── js/
│ └── main.js # Interactivity (theme toggle, mobile nav)
└── pages/
├── getting-started.html # Installation and quick start
├── agents.html # All 24 agents reference
├── commands.html # All 13 commands reference
├── skills.html # All 11 skills reference
├── mcp-servers.html # MCP servers reference
└── changelog.html # Version history
```

### Keeping Docs Up-to-Date

**IMPORTANT:** After ANY change to agents, commands, skills, or MCP servers, run:

```bash
claude /release-docs
```

This command:
1. Counts all current components
2. Reads all agent/command/skill/MCP files
3. Regenerates all reference pages
4. Updates stats on the landing page
5. Updates the changelog from CHANGELOG.md
6. Validates counts match across all files

### Manual Updates

If you need to update docs manually:

1. **Landing page stats** - Update the numbers in `docs/index.html`:
```html
<span class="stat-number">24</span> <!-- agents -->
<span class="stat-number">13</span> <!-- commands -->
```

2. **Reference pages** - Each page in `docs/pages/` documents all components in that category

3. **Changelog** - `docs/pages/changelog.html` mirrors `CHANGELOG.md` in HTML format

### Viewing Docs Locally

Since the docs are static HTML, you can view them directly:

```bash
# Open in browser
open plugins/compounding-engineering/docs/index.html

# Or start a local server
cd plugins/compounding-engineering/docs
python -m http.server 8000
# Then visit http://localhost:8000
```

## Testing Changes

### Test Locally
Expand Down
4 changes: 2 additions & 2 deletions plugins/compounding-engineering/.claude-plugin/plugin.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "compounding-engineering",
"version": "2.5.0",
"description": "AI-powered development tools. 24 agents, 16 commands, 11 skills, 2 MCP servers for code review, research, design, and workflow automation.",
"version": "2.6.0",
"description": "AI-powered development tools. 23 agents, 16 commands, 11 skills, 2 MCP servers for code review, research, design, and workflow automation.",
"author": {
"name": "Kieran Klaassen",
"email": "kieran@every.to",
Expand Down
6 changes: 6 additions & 0 deletions plugins/compounding-engineering/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to the compounding-engineering plugin will be documented in
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.6.0] - 2024-11-26

### Removed

- **`feedback-codifier` agent** - Removed from workflow agents. Agent count reduced from 24 to 23.

## [2.5.0] - 2024-11-25

### Added
Expand Down
5 changes: 2 additions & 3 deletions plugins/compounding-engineering/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ AI-powered development tools that get smarter with every use. Make each unit of

| Component | Count |
|-----------|-------|
| Agents | 24 |
| Agents | 23 |
| Commands | 16 |
| Skills | 11 |
| MCP Servers | 2 |
Expand Down Expand Up @@ -47,13 +47,12 @@ Agents are organized into categories for easier discovery.
| `design-iterator` | Iteratively refine UI through systematic design iterations |
| `figma-design-sync` | Synchronize web implementations with Figma designs |

### Workflow (6)
### Workflow (5)

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

This file was deleted.

112 changes: 112 additions & 0 deletions plugins/compounding-engineering/commands/deploy-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
---
name: deploy-docs
description: Validate and prepare documentation for GitHub Pages deployment
---

# Deploy Documentation Command

Validate the documentation site and prepare it for GitHub Pages deployment.

## Step 1: Validate Documentation

Run these checks:

```bash
# Count components
echo "Agents: $(ls plugins/compounding-engineering/agents/*.md | wc -l)"
echo "Commands: $(ls plugins/compounding-engineering/commands/*.md | wc -l)"
echo "Skills: $(ls -d plugins/compounding-engineering/skills/*/ 2>/dev/null | wc -l)"

# Validate JSON
cat .claude-plugin/marketplace.json | jq . > /dev/null && echo "✓ marketplace.json valid"
cat plugins/compounding-engineering/.claude-plugin/plugin.json | jq . > /dev/null && echo "✓ plugin.json valid"

# Check all HTML files exist
for page in index agents commands skills mcp-servers changelog getting-started; do
if [ -f "plugins/compounding-engineering/docs/pages/${page}.html" ] || [ -f "plugins/compounding-engineering/docs/${page}.html" ]; then
echo "✓ ${page}.html exists"
else
echo "✗ ${page}.html MISSING"
fi
done
```

## Step 2: Check for Uncommitted Changes

```bash
git status --porcelain plugins/compounding-engineering/docs/
```

If there are uncommitted changes, warn the user to commit first.

## Step 3: Deployment Instructions

Since GitHub Pages deployment requires a workflow file with special permissions, provide these instructions:

### First-time Setup

1. Create `.github/workflows/deploy-docs.yml` with the GitHub Pages workflow
2. Go to repository Settings > Pages
3. Set Source to "GitHub Actions"

### Deploying

After merging to `main`, the docs will auto-deploy. Or:

1. Go to Actions tab
2. Select "Deploy Documentation to GitHub Pages"
3. Click "Run workflow"

### Workflow File Content

```yaml
name: Deploy Documentation to GitHub Pages

on:
push:
branches: [main]
paths:
- 'plugins/compounding-engineering/docs/**'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/configure-pages@v4
- uses: actions/upload-pages-artifact@v3
with:
path: 'plugins/compounding-engineering/docs'
- uses: actions/deploy-pages@v4
```

## Step 4: Report Status

Provide a summary:

```
## Deployment Readiness

✓ All HTML pages present
✓ JSON files valid
✓ Component counts match

### Next Steps
- [ ] Commit any pending changes
- [ ] Push to main branch
- [ ] Verify GitHub Pages workflow exists
- [ ] Check deployment at https://everyinc.github.io/every-marketplace/
```
Loading