docs: Add /release-docs command, changelog page, and build instructions
- Add /release-docs command for regenerating documentation site - Add commands/README.md with usage instructions for all commands - Add changelog.html page rendering CHANGELOG.md in HTML format - Add changelog CSS styles to docs.css - Update navigation in all docs pages to include changelog link - Fix command count from 16 to 13 in navigation - Update CLAUDE.md with: - Documentation Site section explaining structure - /release-docs command in update checklist - Instructions for keeping docs up-to-date 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Claude
95
CLAUDE.md
95
CLAUDE.md
@@ -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
|
||||
```
|
||||
@@ -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 .
|
||||
@@ -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
|
||||
|
||||
105
plugins/compounding-engineering/commands/README.md
Normal file
105
plugins/compounding-engineering/commands/README.md
Normal file
@@ -0,0 +1,105 @@
|
||||
# Commands
|
||||
|
||||
This directory contains all slash commands for the compounding-engineering plugin. Each `.md` file defines a command that can be invoked via `claude /command-name`.
|
||||
|
||||
## Documentation Management
|
||||
|
||||
### `/release-docs`
|
||||
|
||||
**Purpose:** Build and update the documentation site with current plugin components.
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
# Full documentation release
|
||||
claude /release-docs
|
||||
|
||||
# Preview changes without writing files
|
||||
claude /release-docs --dry-run
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
1. Inventories all current components (agents, commands, skills, MCP servers)
|
||||
2. Updates `docs/index.html` with accurate stats
|
||||
3. Regenerates reference pages (`agents.html`, `commands.html`, `skills.html`, `mcp-servers.html`)
|
||||
4. Updates `changelog.html` with latest version history
|
||||
5. Ensures counts in `plugin.json` and `marketplace.json` match actual files
|
||||
6. Validates all JSON files
|
||||
|
||||
**When to run:**
|
||||
- After adding, removing, or modifying any agent
|
||||
- After adding, removing, or modifying any command
|
||||
- After adding, removing, or modifying any skill
|
||||
- After adding, removing, or modifying any MCP server
|
||||
- Before releasing a new version
|
||||
|
||||
## Workflow Commands
|
||||
|
||||
### `/plan_review`
|
||||
Multi-agent plan review running in parallel for thorough analysis.
|
||||
|
||||
### `/resolve_parallel`
|
||||
Resolve TODO comments in the codebase in parallel.
|
||||
|
||||
### `/resolve_pr_parallel`
|
||||
Resolve PR comments in parallel.
|
||||
|
||||
### `/resolve_todo_parallel`
|
||||
Resolve TODO items from a list in parallel.
|
||||
|
||||
## Development Commands
|
||||
|
||||
### `/changelog`
|
||||
Create engaging changelogs for recent merges to main branch.
|
||||
|
||||
### `/generate_command`
|
||||
Generate new slash command files from a description.
|
||||
|
||||
### `/create-agent-skill`
|
||||
Create or edit Claude Code skills with best practices.
|
||||
|
||||
### `/heal-skill`
|
||||
Fix skill documentation issues and formatting.
|
||||
|
||||
### `/prime`
|
||||
Prime/setup command for initializing projects.
|
||||
|
||||
### `/reproduce-bug`
|
||||
Reproduce bugs using logs and console output.
|
||||
|
||||
### `/report-bug`
|
||||
Report bugs in the compounding-engineering plugin with structured workflow.
|
||||
|
||||
### `/triage`
|
||||
Triage and prioritize issues.
|
||||
|
||||
## Command File Structure
|
||||
|
||||
Each command file follows this structure:
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: command-name
|
||||
description: Brief description of what the command does
|
||||
argument-hint: "[optional arguments description]"
|
||||
---
|
||||
|
||||
# Command Title
|
||||
|
||||
Instructions for Claude on how to execute this command...
|
||||
```
|
||||
|
||||
## Adding a New Command
|
||||
|
||||
1. Create a new `.md` file in this directory
|
||||
2. Add the frontmatter with `name`, `description`, and optional `argument-hint`
|
||||
3. Write detailed instructions for Claude
|
||||
4. Run `/release-docs` to update documentation
|
||||
5. Test with `claude /your-command-name`
|
||||
|
||||
## Best Practices
|
||||
|
||||
- Keep command names short and descriptive (use hyphens, not underscores)
|
||||
- Provide clear step-by-step instructions
|
||||
- Include examples of expected output
|
||||
- Document any prerequisites or dependencies
|
||||
- Use parallel agent invocation when tasks are independent
|
||||
211
plugins/compounding-engineering/commands/release-docs.md
Normal file
211
plugins/compounding-engineering/commands/release-docs.md
Normal file
@@ -0,0 +1,211 @@
|
||||
---
|
||||
name: release-docs
|
||||
description: Build and update the documentation site with current plugin components
|
||||
argument-hint: "[optional: --dry-run to preview changes without writing]"
|
||||
---
|
||||
|
||||
# Release Documentation Command
|
||||
|
||||
You are a documentation generator for the compounding-engineering plugin. Your job is to ensure the documentation site at `plugins/compounding-engineering/docs/` is always up-to-date with the actual plugin components.
|
||||
|
||||
## Overview
|
||||
|
||||
The documentation site is a static HTML/CSS/JS site based on the Evil Martians LaunchKit template. It needs to be regenerated whenever:
|
||||
|
||||
- Agents are added, removed, or modified
|
||||
- Commands are added, removed, or modified
|
||||
- Skills are added, removed, or modified
|
||||
- MCP servers are added, removed, or modified
|
||||
|
||||
## Step 1: Inventory Current Components
|
||||
|
||||
First, count and list all current components:
|
||||
|
||||
```bash
|
||||
# Count agents
|
||||
ls plugins/compounding-engineering/agents/*.md | wc -l
|
||||
|
||||
# Count commands
|
||||
ls plugins/compounding-engineering/commands/*.md | wc -l
|
||||
|
||||
# Count skills
|
||||
ls -d plugins/compounding-engineering/skills/*/ 2>/dev/null | wc -l
|
||||
|
||||
# Count MCP servers
|
||||
ls -d plugins/compounding-engineering/mcp-servers/*/ 2>/dev/null | wc -l
|
||||
```
|
||||
|
||||
Read all component files to get their metadata:
|
||||
|
||||
### Agents
|
||||
For each agent file in `plugins/compounding-engineering/agents/*.md`:
|
||||
- Extract the frontmatter (name, description)
|
||||
- Note the category (Review, Research, Workflow, Design, Docs)
|
||||
- Get key responsibilities from the content
|
||||
|
||||
### Commands
|
||||
For each command file in `plugins/compounding-engineering/commands/*.md`:
|
||||
- Extract the frontmatter (name, description, argument-hint)
|
||||
- Categorize as Workflow or Utility command
|
||||
|
||||
### Skills
|
||||
For each skill directory in `plugins/compounding-engineering/skills/*/`:
|
||||
- Read the SKILL.md file for frontmatter (name, description)
|
||||
- Note any scripts or supporting files
|
||||
|
||||
### MCP Servers
|
||||
For each MCP server in `plugins/compounding-engineering/mcp-servers/*/`:
|
||||
- Read the configuration and README
|
||||
- List the tools provided
|
||||
|
||||
## Step 2: Update Documentation Pages
|
||||
|
||||
### 2a. Update `docs/index.html`
|
||||
|
||||
Update the stats section with accurate counts:
|
||||
```html
|
||||
<div class="stats-grid">
|
||||
<div class="stat-card">
|
||||
<span class="stat-number">[AGENT_COUNT]</span>
|
||||
<span class="stat-label">Specialized Agents</span>
|
||||
</div>
|
||||
<!-- Update all stat cards -->
|
||||
</div>
|
||||
```
|
||||
|
||||
Ensure the component summary sections list key components accurately.
|
||||
|
||||
### 2b. Update `docs/pages/agents.html`
|
||||
|
||||
Regenerate the complete agents reference page:
|
||||
- Group agents by category (Review, Research, Workflow, Design, Docs)
|
||||
- Include for each agent:
|
||||
- Name and description
|
||||
- Key responsibilities (bullet list)
|
||||
- Usage example: `claude agent [agent-name] "your message"`
|
||||
- Use cases
|
||||
|
||||
### 2c. Update `docs/pages/commands.html`
|
||||
|
||||
Regenerate the complete commands reference page:
|
||||
- Group commands by type (Workflow, Utility)
|
||||
- Include for each command:
|
||||
- Name and description
|
||||
- Arguments (if any)
|
||||
- Process/workflow steps
|
||||
- Example usage
|
||||
|
||||
### 2d. Update `docs/pages/skills.html`
|
||||
|
||||
Regenerate the complete skills reference page:
|
||||
- Group skills by category (Development Tools, Content & Workflow, Image Generation)
|
||||
- Include for each skill:
|
||||
- Name and description
|
||||
- Usage: `claude skill [skill-name]`
|
||||
- Features and capabilities
|
||||
|
||||
### 2e. Update `docs/pages/mcp-servers.html`
|
||||
|
||||
Regenerate the MCP servers reference page:
|
||||
- For each server:
|
||||
- Name and purpose
|
||||
- Tools provided
|
||||
- Configuration details
|
||||
- Supported frameworks/services
|
||||
|
||||
## Step 3: Update Metadata Files
|
||||
|
||||
Ensure counts are consistent across:
|
||||
|
||||
1. **`plugins/compounding-engineering/.claude-plugin/plugin.json`**
|
||||
- Update `description` with correct counts
|
||||
- Update `components` object with counts
|
||||
- Update `agents`, `commands` arrays with current items
|
||||
|
||||
2. **`.claude-plugin/marketplace.json`**
|
||||
- Update plugin `description` with correct counts
|
||||
|
||||
3. **`plugins/compounding-engineering/README.md`**
|
||||
- Update intro paragraph with counts
|
||||
- Update component lists
|
||||
|
||||
## Step 4: Validate
|
||||
|
||||
Run validation checks:
|
||||
|
||||
```bash
|
||||
# Validate JSON files
|
||||
cat .claude-plugin/marketplace.json | jq .
|
||||
cat plugins/compounding-engineering/.claude-plugin/plugin.json | jq .
|
||||
|
||||
# Verify counts match
|
||||
echo "Agents in files: $(ls plugins/compounding-engineering/agents/*.md | wc -l)"
|
||||
grep -o "[0-9]* specialized agents" plugins/compounding-engineering/docs/index.html
|
||||
|
||||
echo "Commands in files: $(ls plugins/compounding-engineering/commands/*.md | wc -l)"
|
||||
grep -o "[0-9]* slash commands" plugins/compounding-engineering/docs/index.html
|
||||
```
|
||||
|
||||
## Step 5: Report Changes
|
||||
|
||||
Provide a summary of what was updated:
|
||||
|
||||
```
|
||||
## Documentation Release Summary
|
||||
|
||||
### Component Counts
|
||||
- Agents: X (previously Y)
|
||||
- Commands: X (previously Y)
|
||||
- Skills: X (previously Y)
|
||||
- MCP Servers: X (previously Y)
|
||||
|
||||
### Files Updated
|
||||
- docs/index.html - Updated stats and component summaries
|
||||
- docs/pages/agents.html - Regenerated with X agents
|
||||
- docs/pages/commands.html - Regenerated with X commands
|
||||
- docs/pages/skills.html - Regenerated with X skills
|
||||
- docs/pages/mcp-servers.html - Regenerated with X servers
|
||||
- plugin.json - Updated counts and component lists
|
||||
- marketplace.json - Updated description
|
||||
- README.md - Updated component lists
|
||||
|
||||
### New Components Added
|
||||
- [List any new agents/commands/skills]
|
||||
|
||||
### Components Removed
|
||||
- [List any removed agents/commands/skills]
|
||||
```
|
||||
|
||||
## Dry Run Mode
|
||||
|
||||
If `--dry-run` is specified:
|
||||
- Perform all inventory and validation steps
|
||||
- Report what WOULD be updated
|
||||
- Do NOT write any files
|
||||
- Show diff previews of proposed changes
|
||||
|
||||
## Error Handling
|
||||
|
||||
- If component files have invalid frontmatter, report the error and skip
|
||||
- If JSON validation fails, report and abort
|
||||
- Always maintain a valid state - don't partially update
|
||||
|
||||
## Post-Release
|
||||
|
||||
After successful release:
|
||||
1. Suggest updating CHANGELOG.md with documentation changes
|
||||
2. Remind to commit with message: `docs: Update documentation site to match plugin components`
|
||||
3. Remind to push changes
|
||||
|
||||
## Usage Examples
|
||||
|
||||
```bash
|
||||
# Full documentation release
|
||||
claude /release-docs
|
||||
|
||||
# Preview changes without writing
|
||||
claude /release-docs --dry-run
|
||||
|
||||
# After adding new agents
|
||||
claude /release-docs
|
||||
```
|
||||
@@ -511,3 +511,165 @@
|
||||
z-index: -1;
|
||||
}
|
||||
}
|
||||
|
||||
/* ============================================
|
||||
Changelog Styles
|
||||
============================================ */
|
||||
|
||||
.version-section {
|
||||
margin-bottom: var(--space-xxl);
|
||||
padding-bottom: var(--space-xl);
|
||||
border-bottom: 1px solid var(--color-border);
|
||||
}
|
||||
|
||||
.version-section:last-child {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
.version-header {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: var(--space-m);
|
||||
margin-bottom: var(--space-l);
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.version-header h2 {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
border: none;
|
||||
font-size: var(--font-size-xl);
|
||||
color: var(--color-text-primary);
|
||||
}
|
||||
|
||||
.version-date {
|
||||
font-size: var(--font-size-s);
|
||||
color: var(--color-text-tertiary);
|
||||
background-color: var(--color-surface);
|
||||
padding: var(--space-xs) var(--space-m);
|
||||
border-radius: var(--radius-s);
|
||||
}
|
||||
|
||||
.version-badge {
|
||||
font-size: var(--font-size-xs);
|
||||
font-weight: 600;
|
||||
padding: var(--space-xs) var(--space-m);
|
||||
border-radius: var(--radius-s);
|
||||
background-color: var(--color-accent);
|
||||
color: white;
|
||||
}
|
||||
|
||||
.version-badge.major {
|
||||
background-color: var(--color-warning);
|
||||
}
|
||||
|
||||
.version-description {
|
||||
font-size: var(--font-size-m);
|
||||
color: var(--color-text-secondary);
|
||||
margin-bottom: var(--space-l);
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.changelog-category {
|
||||
margin-bottom: var(--space-l);
|
||||
padding: var(--space-l);
|
||||
background-color: var(--color-surface);
|
||||
border-radius: var(--radius-m);
|
||||
border-left: 4px solid var(--color-border);
|
||||
}
|
||||
|
||||
.changelog-category h3 {
|
||||
margin: 0 0 var(--space-m) 0;
|
||||
font-size: var(--font-size-m);
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: var(--space-s);
|
||||
}
|
||||
|
||||
.changelog-category h3 i {
|
||||
font-size: var(--font-size-s);
|
||||
}
|
||||
|
||||
.changelog-category h4 {
|
||||
margin: var(--space-l) 0 var(--space-s) 0;
|
||||
font-size: var(--font-size-s);
|
||||
color: var(--color-text-secondary);
|
||||
}
|
||||
|
||||
.changelog-category ul {
|
||||
margin: 0;
|
||||
padding-left: var(--space-xl);
|
||||
}
|
||||
|
||||
.changelog-category li {
|
||||
margin-bottom: var(--space-s);
|
||||
}
|
||||
|
||||
.changelog-category.added {
|
||||
border-left-color: var(--color-success);
|
||||
}
|
||||
|
||||
.changelog-category.added h3 {
|
||||
color: var(--color-success);
|
||||
}
|
||||
|
||||
.changelog-category.improved {
|
||||
border-left-color: var(--color-accent);
|
||||
}
|
||||
|
||||
.changelog-category.improved h3 {
|
||||
color: var(--color-accent);
|
||||
}
|
||||
|
||||
.changelog-category.changed {
|
||||
border-left-color: var(--color-warning);
|
||||
}
|
||||
|
||||
.changelog-category.changed h3 {
|
||||
color: var(--color-warning);
|
||||
}
|
||||
|
||||
.changelog-category.fixed {
|
||||
border-left-color: var(--color-error);
|
||||
}
|
||||
|
||||
.changelog-category.fixed h3 {
|
||||
color: var(--color-error);
|
||||
}
|
||||
|
||||
.version-summary {
|
||||
margin-top: var(--space-l);
|
||||
}
|
||||
|
||||
.version-summary h4 {
|
||||
margin-bottom: var(--space-m);
|
||||
}
|
||||
|
||||
.version-summary table {
|
||||
width: 100%;
|
||||
max-width: 400px;
|
||||
border-collapse: collapse;
|
||||
font-size: var(--font-size-s);
|
||||
}
|
||||
|
||||
.version-summary th,
|
||||
.version-summary td {
|
||||
padding: var(--space-s) var(--space-m);
|
||||
text-align: left;
|
||||
border-bottom: 1px solid var(--color-border);
|
||||
}
|
||||
|
||||
.version-summary th {
|
||||
font-weight: 600;
|
||||
background-color: var(--color-surface);
|
||||
}
|
||||
|
||||
.version-summary .positive {
|
||||
color: var(--color-success);
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.version-summary .negative {
|
||||
color: var(--color-error);
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
@@ -34,11 +34,17 @@
|
||||
<h3>Reference</h3>
|
||||
<ul>
|
||||
<li><a href="agents.html" class="active">Agents (24)</a></li>
|
||||
<li><a href="commands.html">Commands (16)</a></li>
|
||||
<li><a href="commands.html">Commands (13)</a></li>
|
||||
<li><a href="skills.html">Skills (11)</a></li>
|
||||
<li><a href="mcp-servers.html">MCP Servers (2)</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-section">
|
||||
<h3>Resources</h3>
|
||||
<ul>
|
||||
<li><a href="changelog.html">Changelog</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-section">
|
||||
<h3>On This Page</h3>
|
||||
<ul>
|
||||
|
||||
476
plugins/compounding-engineering/docs/pages/changelog.html
Normal file
476
plugins/compounding-engineering/docs/pages/changelog.html
Normal file
@@ -0,0 +1,476 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="theme-dark">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Changelog - Compounding Engineering</title>
|
||||
<meta content="Version history and release notes for the Compounding Engineering plugin." name="description" />
|
||||
<meta content="width=device-width, initial-scale=1" name="viewport" />
|
||||
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css" />
|
||||
<link href="../css/style.css" rel="stylesheet" type="text/css" />
|
||||
<link href="../css/docs.css" rel="stylesheet" type="text/css" />
|
||||
<script src="../js/main.js" type="text/javascript" defer></script>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div class="background-gradient"></div>
|
||||
<div class="docs-layout">
|
||||
<aside class="docs-sidebar">
|
||||
<div class="sidebar-header">
|
||||
<a href="../index.html" class="nav-brand">
|
||||
<span class="logo-icon"><i class="fa-solid fa-layer-group"></i></span>
|
||||
<span class="logo-text">CE Docs</span>
|
||||
</a>
|
||||
</div>
|
||||
<nav class="sidebar-nav">
|
||||
<div class="nav-section">
|
||||
<h3>Getting Started</h3>
|
||||
<ul>
|
||||
<li><a href="getting-started.html">Installation</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-section">
|
||||
<h3>Reference</h3>
|
||||
<ul>
|
||||
<li><a href="agents.html">Agents (24)</a></li>
|
||||
<li><a href="commands.html">Commands (13)</a></li>
|
||||
<li><a href="skills.html">Skills (11)</a></li>
|
||||
<li><a href="mcp-servers.html">MCP Servers (2)</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-section">
|
||||
<h3>Resources</h3>
|
||||
<ul>
|
||||
<li><a href="changelog.html" class="active">Changelog</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-section">
|
||||
<h3>On This Page</h3>
|
||||
<ul>
|
||||
<li><a href="#v2.5.0">v2.5.0</a></li>
|
||||
<li><a href="#v2.4.1">v2.4.1</a></li>
|
||||
<li><a href="#v2.4.0">v2.4.0</a></li>
|
||||
<li><a href="#v2.3.0">v2.3.0</a></li>
|
||||
<li><a href="#v2.2.1">v2.2.1</a></li>
|
||||
<li><a href="#v2.2.0">v2.2.0</a></li>
|
||||
<li><a href="#v2.1.0">v2.1.0</a></li>
|
||||
<li><a href="#v2.0.0">v2.0.0</a></li>
|
||||
<li><a href="#v1.1.0">v1.1.0</a></li>
|
||||
<li><a href="#v1.0.0">v1.0.0</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
</aside>
|
||||
|
||||
<main class="docs-content">
|
||||
<div class="docs-header">
|
||||
<nav class="breadcrumb">
|
||||
<a href="../index.html">Home</a>
|
||||
<span>/</span>
|
||||
<a href="getting-started.html">Docs</a>
|
||||
<span>/</span>
|
||||
<span>Changelog</span>
|
||||
</nav>
|
||||
<button class="mobile-menu-toggle" data-sidebar-toggle>
|
||||
<i class="fa-solid fa-bars"></i>
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<article class="docs-article">
|
||||
<h1><i class="fa-solid fa-clock-rotate-left color-accent"></i> Changelog</h1>
|
||||
<p class="lead">
|
||||
All notable changes to the compounding-engineering plugin. This project follows
|
||||
<a href="https://semver.org/">Semantic Versioning</a> and
|
||||
<a href="https://keepachangelog.com/">Keep a Changelog</a> conventions.
|
||||
</p>
|
||||
|
||||
<!-- Version 2.5.0 -->
|
||||
<section id="v2.5.0" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v2.5.0</h2>
|
||||
<span class="version-date">2024-11-25</span>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category added">
|
||||
<h3><i class="fa-solid fa-plus"></i> Added</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<strong><code>/report-bug</code> command</strong> - New slash command for reporting bugs in the
|
||||
compounding-engineering plugin. Provides a structured workflow that gathers bug information
|
||||
through guided questions, collects environment details automatically, and creates a GitHub
|
||||
issue in the EveryInc/every-marketplace repository.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Version 2.4.1 -->
|
||||
<section id="v2.4.1" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v2.4.1</h2>
|
||||
<span class="version-date">2024-11-24</span>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category improved">
|
||||
<h3><i class="fa-solid fa-arrow-up"></i> Improved</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>design-iterator agent</strong> - Added focused screenshot guidance: always capture
|
||||
only the target element/area instead of full page screenshots. Includes browser_resize
|
||||
recommendations, element-targeted screenshot workflow using browser_snapshot refs, and
|
||||
explicit instruction to never use fullPage mode.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Version 2.4.0 -->
|
||||
<section id="v2.4.0" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v2.4.0</h2>
|
||||
<span class="version-date">2024-11-24</span>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category fixed">
|
||||
<h3><i class="fa-solid fa-bug"></i> Fixed</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>MCP Configuration</strong> - Moved MCP servers back to <code>plugin.json</code>
|
||||
following working examples from anthropics/life-sciences plugins.
|
||||
</li>
|
||||
<li>
|
||||
<strong>Context7 URL</strong> - Updated to use HTTP type with correct endpoint URL.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Version 2.3.0 -->
|
||||
<section id="v2.3.0" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v2.3.0</h2>
|
||||
<span class="version-date">2024-11-24</span>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category changed">
|
||||
<h3><i class="fa-solid fa-arrows-rotate"></i> Changed</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>MCP Configuration</strong> - Moved MCP servers from inline <code>plugin.json</code>
|
||||
to separate <code>.mcp.json</code> file per Claude Code best practices.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Version 2.2.1 -->
|
||||
<section id="v2.2.1" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v2.2.1</h2>
|
||||
<span class="version-date">2024-11-24</span>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category fixed">
|
||||
<h3><i class="fa-solid fa-bug"></i> Fixed</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Playwright MCP Server</strong> - Added missing <code>"type": "stdio"</code> field
|
||||
required for MCP server configuration to load properly.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Version 2.2.0 -->
|
||||
<section id="v2.2.0" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v2.2.0</h2>
|
||||
<span class="version-date">2024-11-24</span>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category added">
|
||||
<h3><i class="fa-solid fa-plus"></i> Added</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Context7 MCP Server</strong> - Bundled Context7 for instant framework documentation
|
||||
lookup. Provides up-to-date docs for Rails, React, Next.js, and 100+ other frameworks.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Version 2.1.0 -->
|
||||
<section id="v2.1.0" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v2.1.0</h2>
|
||||
<span class="version-date">2024-11-24</span>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category added">
|
||||
<h3><i class="fa-solid fa-plus"></i> Added</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Playwright MCP Server</strong> - Bundled <code>@playwright/mcp</code> for browser
|
||||
automation across all projects. Provides screenshot, navigation, click, fill, and evaluate tools.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category changed">
|
||||
<h3><i class="fa-solid fa-arrows-rotate"></i> Changed</h3>
|
||||
<ul>
|
||||
<li>Replaced all Puppeteer references with Playwright across agents and commands:
|
||||
<ul>
|
||||
<li><code>bug-reproduction-validator</code> agent</li>
|
||||
<li><code>design-iterator</code> agent</li>
|
||||
<li><code>design-implementation-reviewer</code> agent</li>
|
||||
<li><code>figma-design-sync</code> agent</li>
|
||||
<li><code>generate_command</code> command</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Version 2.0.2 -->
|
||||
<section id="v2.0.2" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v2.0.2</h2>
|
||||
<span class="version-date">2024-11-24</span>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category changed">
|
||||
<h3><i class="fa-solid fa-arrows-rotate"></i> Changed</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>design-iterator agent</strong> - Updated description to emphasize proactive usage
|
||||
when design work isn't coming together on first attempt.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Version 2.0.1 -->
|
||||
<section id="v2.0.1" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v2.0.1</h2>
|
||||
<span class="version-date">2024-11-24</span>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category added">
|
||||
<h3><i class="fa-solid fa-plus"></i> Added</h3>
|
||||
<ul>
|
||||
<li><strong>CLAUDE.md</strong> - Project instructions with versioning requirements</li>
|
||||
<li><strong>docs/solutions/plugin-versioning-requirements.md</strong> - Workflow documentation</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Version 2.0.0 -->
|
||||
<section id="v2.0.0" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v2.0.0</h2>
|
||||
<span class="version-date">2024-11-24</span>
|
||||
<span class="version-badge major">Major Release</span>
|
||||
</div>
|
||||
|
||||
<p class="version-description">
|
||||
Major reorganization consolidating agents, commands, and skills from multiple sources into
|
||||
a single, well-organized plugin.
|
||||
</p>
|
||||
|
||||
<div class="changelog-category added">
|
||||
<h3><i class="fa-solid fa-plus"></i> Added</h3>
|
||||
|
||||
<h4>New Agents (7)</h4>
|
||||
<ul>
|
||||
<li><code>design-iterator</code> - Iteratively refine UI components through systematic design iterations</li>
|
||||
<li><code>design-implementation-reviewer</code> - Verify UI implementations match Figma design specifications</li>
|
||||
<li><code>figma-design-sync</code> - Synchronize web implementations with Figma designs</li>
|
||||
<li><code>bug-reproduction-validator</code> - Systematically reproduce and validate bug reports</li>
|
||||
<li><code>spec-flow-analyzer</code> - Analyze user flows and identify gaps in specifications</li>
|
||||
<li><code>lint</code> - Run linting and code quality checks on Ruby and ERB files</li>
|
||||
<li><code>ankane-readme-writer</code> - Create READMEs following Ankane-style template for Ruby gems</li>
|
||||
</ul>
|
||||
|
||||
<h4>New Commands (9)</h4>
|
||||
<ul>
|
||||
<li><code>/changelog</code> - Create engaging changelogs for recent merges</li>
|
||||
<li><code>/plan_review</code> - Multi-agent plan review in parallel</li>
|
||||
<li><code>/resolve_parallel</code> - Resolve TODO comments in parallel</li>
|
||||
<li><code>/resolve_pr_parallel</code> - Resolve PR comments in parallel</li>
|
||||
<li><code>/reproduce-bug</code> - Reproduce bugs using logs and console</li>
|
||||
<li><code>/prime</code> - Prime/setup command</li>
|
||||
<li><code>/create-agent-skill</code> - Create or edit Claude Code skills</li>
|
||||
<li><code>/heal-skill</code> - Fix skill documentation issues</li>
|
||||
<li><code>/workflows:codify</code> - Document solved problems for knowledge base</li>
|
||||
</ul>
|
||||
|
||||
<h4>New Skills (10)</h4>
|
||||
<ul>
|
||||
<li><code>andrew-kane-gem-writer</code> - Write Ruby gems following Andrew Kane's patterns</li>
|
||||
<li><code>codify-docs</code> - Capture solved problems as categorized documentation</li>
|
||||
<li><code>create-agent-skills</code> - Expert guidance for creating Claude Code skills</li>
|
||||
<li><code>dhh-ruby-style</code> - Write Ruby/Rails code in DHH's 37signals style</li>
|
||||
<li><code>dspy-ruby</code> - Build type-safe LLM applications with DSPy.rb</li>
|
||||
<li><code>every-style-editor</code> - Review copy for Every's style guide compliance</li>
|
||||
<li><code>file-todos</code> - File-based todo tracking system</li>
|
||||
<li><code>frontend-design</code> - Create production-grade frontend interfaces</li>
|
||||
<li><code>git-worktree</code> - Manage Git worktrees for parallel development</li>
|
||||
<li><code>skill-creator</code> - Guide for creating effective Claude Code skills</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category changed">
|
||||
<h3><i class="fa-solid fa-arrows-rotate"></i> Changed</h3>
|
||||
<h4>Agents Reorganized by Category</h4>
|
||||
<ul>
|
||||
<li><code>review/</code> (10 agents) - Code quality, security, performance reviewers</li>
|
||||
<li><code>research/</code> (4 agents) - Documentation, patterns, history analysis</li>
|
||||
<li><code>design/</code> (3 agents) - UI/design review and iteration</li>
|
||||
<li><code>workflow/</code> (6 agents) - PR resolution, bug validation, linting</li>
|
||||
<li><code>docs/</code> (1 agent) - README generation</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="version-summary">
|
||||
<h4>Summary</h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>v1.1.0</th>
|
||||
<th>v2.0.0</th>
|
||||
<th>Change</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Agents</td>
|
||||
<td>17</td>
|
||||
<td>24</td>
|
||||
<td class="positive">+7</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Commands</td>
|
||||
<td>6</td>
|
||||
<td>15</td>
|
||||
<td class="positive">+9</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Skills</td>
|
||||
<td>1</td>
|
||||
<td>11</td>
|
||||
<td class="positive">+10</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Version 1.1.0 -->
|
||||
<section id="v1.1.0" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v1.1.0</h2>
|
||||
<span class="version-date">2024-11-22</span>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category added">
|
||||
<h3><i class="fa-solid fa-plus"></i> Added</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>gemini-imagegen Skill</strong>
|
||||
<ul>
|
||||
<li>Text-to-image generation with Google's Gemini API</li>
|
||||
<li>Image editing and manipulation</li>
|
||||
<li>Multi-turn refinement via chat interface</li>
|
||||
<li>Multiple reference image composition (up to 14 images)</li>
|
||||
<li>Model support: <code>gemini-2.5-flash-image</code> and <code>gemini-3-pro-image-preview</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category fixed">
|
||||
<h3><i class="fa-solid fa-bug"></i> Fixed</h3>
|
||||
<ul>
|
||||
<li>Corrected component counts in documentation (17 agents, not 15)</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Version 1.0.0 -->
|
||||
<section id="v1.0.0" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v1.0.0</h2>
|
||||
<span class="version-date">2024-10-09</span>
|
||||
<span class="version-badge">Initial Release</span>
|
||||
</div>
|
||||
|
||||
<p class="version-description">
|
||||
Initial release of the compounding-engineering plugin.
|
||||
</p>
|
||||
|
||||
<div class="changelog-category added">
|
||||
<h3><i class="fa-solid fa-plus"></i> Added</h3>
|
||||
|
||||
<h4>17 Specialized Agents</h4>
|
||||
|
||||
<p><strong>Code Review (5)</strong></p>
|
||||
<ul>
|
||||
<li><code>kieran-rails-reviewer</code> - Rails code review with strict conventions</li>
|
||||
<li><code>kieran-python-reviewer</code> - Python code review with quality standards</li>
|
||||
<li><code>kieran-typescript-reviewer</code> - TypeScript code review</li>
|
||||
<li><code>dhh-rails-reviewer</code> - Rails review from DHH's perspective</li>
|
||||
<li><code>code-simplicity-reviewer</code> - Final pass for simplicity and minimalism</li>
|
||||
</ul>
|
||||
|
||||
<p><strong>Analysis & Architecture (4)</strong></p>
|
||||
<ul>
|
||||
<li><code>architecture-strategist</code> - Architectural decisions and compliance</li>
|
||||
<li><code>pattern-recognition-specialist</code> - Design pattern analysis</li>
|
||||
<li><code>security-sentinel</code> - Security audits and vulnerability assessments</li>
|
||||
<li><code>performance-oracle</code> - Performance analysis and optimization</li>
|
||||
</ul>
|
||||
|
||||
<p><strong>Research (4)</strong></p>
|
||||
<ul>
|
||||
<li><code>framework-docs-researcher</code> - Framework documentation research</li>
|
||||
<li><code>best-practices-researcher</code> - External best practices gathering</li>
|
||||
<li><code>git-history-analyzer</code> - Git history and code evolution analysis</li>
|
||||
<li><code>repo-research-analyst</code> - Repository structure and conventions</li>
|
||||
</ul>
|
||||
|
||||
<p><strong>Workflow (3)</strong></p>
|
||||
<ul>
|
||||
<li><code>every-style-editor</code> - Every's style guide compliance</li>
|
||||
<li><code>pr-comment-resolver</code> - PR comment resolution</li>
|
||||
<li><code>feedback-codifier</code> - Feedback pattern codification</li>
|
||||
</ul>
|
||||
|
||||
<h4>6 Slash Commands</h4>
|
||||
<ul>
|
||||
<li><code>/plan</code> - Create implementation plans</li>
|
||||
<li><code>/review</code> - Comprehensive code reviews</li>
|
||||
<li><code>/work</code> - Execute work items systematically</li>
|
||||
<li><code>/triage</code> - Triage and prioritize issues</li>
|
||||
<li><code>/resolve_todo_parallel</code> - Resolve TODOs in parallel</li>
|
||||
<li><code>/generate_command</code> - Generate new slash commands</li>
|
||||
</ul>
|
||||
|
||||
<h4>Infrastructure</h4>
|
||||
<ul>
|
||||
<li>MIT license</li>
|
||||
<li>Plugin manifest (<code>plugin.json</code>)</li>
|
||||
<li>Pre-configured permissions for Rails development</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</main>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
@@ -34,11 +34,17 @@
|
||||
<h3>Reference</h3>
|
||||
<ul>
|
||||
<li><a href="agents.html">Agents (24)</a></li>
|
||||
<li><a href="commands.html" class="active">Commands (16)</a></li>
|
||||
<li><a href="commands.html" class="active">Commands (13)</a></li>
|
||||
<li><a href="skills.html">Skills (11)</a></li>
|
||||
<li><a href="mcp-servers.html">MCP Servers (2)</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-section">
|
||||
<h3>Resources</h3>
|
||||
<ul>
|
||||
<li><a href="changelog.html">Changelog</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-section">
|
||||
<h3>On This Page</h3>
|
||||
<ul>
|
||||
|
||||
@@ -58,6 +58,7 @@
|
||||
<li><a href="commands.html">Command Reference</a></li>
|
||||
<li><a href="skills.html">Skill Reference</a></li>
|
||||
<li><a href="mcp-servers.html">MCP Servers</a></li>
|
||||
<li><a href="changelog.html">Changelog</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
@@ -34,11 +34,17 @@
|
||||
<h3>Reference</h3>
|
||||
<ul>
|
||||
<li><a href="agents.html">Agents (24)</a></li>
|
||||
<li><a href="commands.html">Commands (16)</a></li>
|
||||
<li><a href="commands.html">Commands (13)</a></li>
|
||||
<li><a href="skills.html">Skills (11)</a></li>
|
||||
<li><a href="mcp-servers.html" class="active">MCP Servers (2)</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-section">
|
||||
<h3>Resources</h3>
|
||||
<ul>
|
||||
<li><a href="changelog.html">Changelog</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-section">
|
||||
<h3>On This Page</h3>
|
||||
<ul>
|
||||
|
||||
@@ -34,11 +34,17 @@
|
||||
<h3>Reference</h3>
|
||||
<ul>
|
||||
<li><a href="agents.html">Agents (24)</a></li>
|
||||
<li><a href="commands.html">Commands (16)</a></li>
|
||||
<li><a href="commands.html">Commands (13)</a></li>
|
||||
<li><a href="skills.html" class="active">Skills (11)</a></li>
|
||||
<li><a href="mcp-servers.html">MCP Servers (2)</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-section">
|
||||
<h3>Resources</h3>
|
||||
<ul>
|
||||
<li><a href="changelog.html">Changelog</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-section">
|
||||
<h3>On This Page</h3>
|
||||
<ul>
|
||||
|
||||
Reference in New Issue
Block a user