chore: Remove GitHub Pages documentation site
The static docs site (index.html, css/, js/, pages/) is unused. Working directories (plans/, brainstorms/, solutions/, specs/) are kept. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Kieran Klaassen
@@ -1,675 +0,0 @@
|
||||
/* Documentation-specific styles */
|
||||
|
||||
/* ============================================
|
||||
Documentation Layout
|
||||
============================================ */
|
||||
|
||||
.docs-layout {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr;
|
||||
min-height: 100vh;
|
||||
}
|
||||
|
||||
@media (min-width: 1024px) {
|
||||
.docs-layout {
|
||||
grid-template-columns: 280px 1fr;
|
||||
}
|
||||
}
|
||||
|
||||
/* ============================================
|
||||
Sidebar
|
||||
============================================ */
|
||||
|
||||
.docs-sidebar {
|
||||
position: fixed;
|
||||
top: 0;
|
||||
left: -300px;
|
||||
width: 280px;
|
||||
height: 100vh;
|
||||
background-color: var(--color-background);
|
||||
border-right: 1px solid var(--color-border);
|
||||
overflow-y: auto;
|
||||
transition: left 0.3s ease;
|
||||
z-index: 100;
|
||||
}
|
||||
|
||||
.docs-sidebar.open {
|
||||
left: 0;
|
||||
}
|
||||
|
||||
@media (min-width: 1024px) {
|
||||
.docs-sidebar {
|
||||
position: sticky;
|
||||
left: 0;
|
||||
}
|
||||
}
|
||||
|
||||
.sidebar-header {
|
||||
padding: var(--space-l);
|
||||
border-bottom: 1px solid var(--color-border);
|
||||
}
|
||||
|
||||
.sidebar-header .nav-brand {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: var(--space-s);
|
||||
text-decoration: none;
|
||||
color: var(--color-text-primary);
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.sidebar-header .logo-icon {
|
||||
color: var(--color-accent);
|
||||
font-size: var(--font-size-l);
|
||||
}
|
||||
|
||||
.sidebar-header .logo-text {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
.sidebar-nav {
|
||||
padding: var(--space-l);
|
||||
}
|
||||
|
||||
.nav-section {
|
||||
margin-bottom: var(--space-xl);
|
||||
}
|
||||
|
||||
.nav-section h3 {
|
||||
font-size: var(--font-size-xs);
|
||||
font-weight: 600;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.05em;
|
||||
color: var(--color-text-tertiary);
|
||||
margin: 0 0 var(--space-m) 0;
|
||||
}
|
||||
|
||||
.nav-section ul {
|
||||
list-style: none;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.nav-section li {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.nav-section a {
|
||||
display: block;
|
||||
padding: var(--space-s) var(--space-m);
|
||||
color: var(--color-text-secondary);
|
||||
text-decoration: none;
|
||||
font-size: var(--font-size-s);
|
||||
border-radius: var(--radius-s);
|
||||
transition: all 0.2s ease;
|
||||
}
|
||||
|
||||
.nav-section a:hover {
|
||||
color: var(--color-text-primary);
|
||||
background-color: var(--color-surface);
|
||||
}
|
||||
|
||||
.nav-section a.active {
|
||||
color: var(--color-accent);
|
||||
background-color: var(--color-accent-light);
|
||||
}
|
||||
|
||||
/* ============================================
|
||||
Main Content
|
||||
============================================ */
|
||||
|
||||
.docs-content {
|
||||
padding: var(--space-xl);
|
||||
max-width: 900px;
|
||||
}
|
||||
|
||||
@media (min-width: 1024px) {
|
||||
.docs-content {
|
||||
padding: var(--space-xxl);
|
||||
}
|
||||
}
|
||||
|
||||
.docs-header {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
margin-bottom: var(--space-xl);
|
||||
}
|
||||
|
||||
.breadcrumb {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: var(--space-s);
|
||||
font-size: var(--font-size-s);
|
||||
color: var(--color-text-tertiary);
|
||||
}
|
||||
|
||||
.breadcrumb a {
|
||||
color: var(--color-text-secondary);
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.breadcrumb a:hover {
|
||||
color: var(--color-accent);
|
||||
}
|
||||
|
||||
.mobile-menu-toggle {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
background: none;
|
||||
border: 1px solid var(--color-border);
|
||||
border-radius: var(--radius-s);
|
||||
color: var(--color-text-secondary);
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
@media (min-width: 1024px) {
|
||||
.mobile-menu-toggle {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
|
||||
/* ============================================
|
||||
Article Styles
|
||||
============================================ */
|
||||
|
||||
.docs-article {
|
||||
line-height: 1.7;
|
||||
}
|
||||
|
||||
.docs-article h1 {
|
||||
font-size: var(--font-size-xl);
|
||||
margin-bottom: var(--space-l);
|
||||
}
|
||||
|
||||
.docs-article h2 {
|
||||
font-size: var(--font-size-l);
|
||||
margin-top: var(--space-xxl);
|
||||
margin-bottom: var(--space-l);
|
||||
padding-bottom: var(--space-s);
|
||||
border-bottom: 1px solid var(--color-border);
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: var(--space-s);
|
||||
}
|
||||
|
||||
.docs-article h2 i {
|
||||
color: var(--color-accent);
|
||||
}
|
||||
|
||||
.docs-article h3 {
|
||||
font-size: var(--font-size-m);
|
||||
margin-top: var(--space-xl);
|
||||
margin-bottom: var(--space-m);
|
||||
}
|
||||
|
||||
.docs-article h4 {
|
||||
font-size: var(--font-size-s);
|
||||
margin-top: var(--space-l);
|
||||
margin-bottom: var(--space-s);
|
||||
}
|
||||
|
||||
.docs-article p {
|
||||
margin-bottom: var(--space-l);
|
||||
}
|
||||
|
||||
.docs-article .lead {
|
||||
font-size: var(--font-size-l);
|
||||
color: var(--color-text-secondary);
|
||||
margin-bottom: var(--space-xl);
|
||||
}
|
||||
|
||||
.docs-article ul,
|
||||
.docs-article ol {
|
||||
margin-bottom: var(--space-l);
|
||||
padding-left: var(--space-xl);
|
||||
}
|
||||
|
||||
.docs-article li {
|
||||
margin-bottom: var(--space-s);
|
||||
}
|
||||
|
||||
/* ============================================
|
||||
Code Blocks in Docs
|
||||
============================================ */
|
||||
|
||||
.docs-article .card-code-block {
|
||||
margin: var(--space-l) 0;
|
||||
}
|
||||
|
||||
.docs-article code {
|
||||
font-family: var(--font-mono);
|
||||
font-size: 0.9em;
|
||||
background-color: var(--color-surface);
|
||||
padding: 2px 6px;
|
||||
border-radius: var(--radius-xs);
|
||||
color: var(--color-accent);
|
||||
}
|
||||
|
||||
.docs-article pre code {
|
||||
background: none;
|
||||
padding: 0;
|
||||
color: var(--color-code-text);
|
||||
}
|
||||
|
||||
/* ============================================
|
||||
Tables
|
||||
============================================ */
|
||||
|
||||
.docs-table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
margin: var(--space-l) 0;
|
||||
font-size: var(--font-size-s);
|
||||
}
|
||||
|
||||
.docs-table th,
|
||||
.docs-table td {
|
||||
padding: var(--space-m);
|
||||
text-align: left;
|
||||
border-bottom: 1px solid var(--color-border);
|
||||
}
|
||||
|
||||
.docs-table th {
|
||||
font-weight: 600;
|
||||
color: var(--color-text-primary);
|
||||
background-color: var(--color-surface);
|
||||
}
|
||||
|
||||
.docs-table td {
|
||||
color: var(--color-text-secondary);
|
||||
}
|
||||
|
||||
.docs-table code {
|
||||
font-size: 0.85em;
|
||||
}
|
||||
|
||||
/* ============================================
|
||||
Callouts
|
||||
============================================ */
|
||||
|
||||
.callout {
|
||||
display: flex;
|
||||
gap: var(--space-m);
|
||||
padding: var(--space-l);
|
||||
border-radius: var(--radius-m);
|
||||
margin: var(--space-l) 0;
|
||||
}
|
||||
|
||||
.callout-icon {
|
||||
font-size: var(--font-size-l);
|
||||
flex-shrink: 0;
|
||||
}
|
||||
|
||||
.callout-content h4 {
|
||||
margin: 0 0 var(--space-s) 0;
|
||||
font-size: var(--font-size-s);
|
||||
}
|
||||
|
||||
.callout-content p {
|
||||
margin: 0;
|
||||
font-size: var(--font-size-s);
|
||||
}
|
||||
|
||||
.callout-info {
|
||||
background-color: rgba(99, 102, 241, 0.1);
|
||||
border: 1px solid rgba(99, 102, 241, 0.2);
|
||||
}
|
||||
|
||||
.callout-info .callout-icon {
|
||||
color: var(--color-accent);
|
||||
}
|
||||
|
||||
.callout-info .callout-content h4 {
|
||||
color: var(--color-accent);
|
||||
}
|
||||
|
||||
.callout-tip {
|
||||
background-color: rgba(16, 185, 129, 0.1);
|
||||
border: 1px solid rgba(16, 185, 129, 0.2);
|
||||
}
|
||||
|
||||
.callout-tip .callout-icon {
|
||||
color: var(--color-success);
|
||||
}
|
||||
|
||||
.callout-tip .callout-content h4 {
|
||||
color: var(--color-success);
|
||||
}
|
||||
|
||||
.callout-warning {
|
||||
background-color: rgba(245, 158, 11, 0.1);
|
||||
border: 1px solid rgba(245, 158, 11, 0.2);
|
||||
}
|
||||
|
||||
.callout-warning .callout-icon {
|
||||
color: var(--color-warning);
|
||||
}
|
||||
|
||||
.callout-warning .callout-content h4 {
|
||||
color: var(--color-warning);
|
||||
}
|
||||
|
||||
/* ============================================
|
||||
Badges
|
||||
============================================ */
|
||||
|
||||
.badge {
|
||||
display: inline-block;
|
||||
padding: 2px 8px;
|
||||
font-size: var(--font-size-xs);
|
||||
font-weight: 600;
|
||||
border-radius: var(--radius-s);
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.03em;
|
||||
}
|
||||
|
||||
.badge-critical {
|
||||
background-color: rgba(239, 68, 68, 0.15);
|
||||
color: var(--color-error);
|
||||
}
|
||||
|
||||
.badge-important {
|
||||
background-color: rgba(245, 158, 11, 0.15);
|
||||
color: var(--color-warning);
|
||||
}
|
||||
|
||||
.badge-nice {
|
||||
background-color: rgba(99, 102, 241, 0.15);
|
||||
color: var(--color-accent);
|
||||
}
|
||||
|
||||
/* ============================================
|
||||
Philosophy Grid
|
||||
============================================ */
|
||||
|
||||
.philosophy-grid {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(1, 1fr);
|
||||
gap: var(--space-l);
|
||||
margin: var(--space-xl) 0;
|
||||
}
|
||||
|
||||
@media (min-width: 640px) {
|
||||
.philosophy-grid {
|
||||
grid-template-columns: repeat(2, 1fr);
|
||||
}
|
||||
}
|
||||
|
||||
.philosophy-card {
|
||||
padding: var(--space-xl);
|
||||
background-color: var(--color-surface);
|
||||
border-radius: var(--radius-m);
|
||||
border: 1px solid var(--color-border);
|
||||
}
|
||||
|
||||
.philosophy-icon {
|
||||
font-size: var(--font-size-xl);
|
||||
color: var(--color-accent);
|
||||
margin-bottom: var(--space-m);
|
||||
}
|
||||
|
||||
.philosophy-card h4 {
|
||||
margin: 0 0 var(--space-s) 0;
|
||||
color: var(--color-text-primary);
|
||||
}
|
||||
|
||||
.philosophy-card p {
|
||||
margin: 0;
|
||||
font-size: var(--font-size-s);
|
||||
color: var(--color-text-secondary);
|
||||
}
|
||||
|
||||
/* ============================================
|
||||
Blockquotes
|
||||
============================================ */
|
||||
|
||||
.highlight-quote {
|
||||
font-size: var(--font-size-l);
|
||||
font-style: italic;
|
||||
color: var(--color-accent);
|
||||
padding: var(--space-xl);
|
||||
margin: var(--space-xl) 0;
|
||||
background: linear-gradient(135deg, var(--color-accent-lighter), transparent);
|
||||
border-left: 4px solid var(--color-accent);
|
||||
border-radius: var(--radius-m);
|
||||
}
|
||||
|
||||
/* ============================================
|
||||
Navigation Footer
|
||||
============================================ */
|
||||
|
||||
.docs-nav-footer {
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
gap: var(--space-l);
|
||||
margin-top: var(--space-xxl);
|
||||
padding-top: var(--space-xl);
|
||||
border-top: 1px solid var(--color-border);
|
||||
}
|
||||
|
||||
.nav-prev,
|
||||
.nav-next {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: var(--space-xs);
|
||||
padding: var(--space-l);
|
||||
background-color: var(--color-surface);
|
||||
border-radius: var(--radius-m);
|
||||
text-decoration: none;
|
||||
transition: all 0.2s ease;
|
||||
flex: 1;
|
||||
max-width: 300px;
|
||||
}
|
||||
|
||||
.nav-prev:hover,
|
||||
.nav-next:hover {
|
||||
background-color: var(--color-surface-hover);
|
||||
border-color: var(--color-accent);
|
||||
}
|
||||
|
||||
.nav-next {
|
||||
text-align: right;
|
||||
margin-left: auto;
|
||||
}
|
||||
|
||||
.nav-label {
|
||||
font-size: var(--font-size-xs);
|
||||
color: var(--color-text-tertiary);
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.05em;
|
||||
}
|
||||
|
||||
.nav-title {
|
||||
font-weight: 600;
|
||||
color: var(--color-accent);
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: var(--space-s);
|
||||
}
|
||||
|
||||
.nav-next .nav-title {
|
||||
justify-content: flex-end;
|
||||
}
|
||||
|
||||
/* ============================================
|
||||
Mobile Sidebar Overlay
|
||||
============================================ */
|
||||
|
||||
@media (max-width: 1023px) {
|
||||
.docs-sidebar.open::before {
|
||||
content: '';
|
||||
position: fixed;
|
||||
top: 0;
|
||||
left: 0;
|
||||
right: 0;
|
||||
bottom: 0;
|
||||
background-color: rgba(0, 0, 0, 0.5);
|
||||
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;
|
||||
}
|
||||
2886
docs/css/style.css
2886
docs/css/style.css
File diff suppressed because it is too large
Load Diff
1046
docs/index.html
1046
docs/index.html
File diff suppressed because it is too large
Load Diff
225
docs/js/main.js
225
docs/js/main.js
@@ -1,225 +0,0 @@
|
||||
/**
|
||||
* Compounding Engineering Documentation
|
||||
* Main JavaScript functionality
|
||||
*/
|
||||
|
||||
document.addEventListener('DOMContentLoaded', () => {
|
||||
initMobileNav();
|
||||
initSmoothScroll();
|
||||
initCopyCode();
|
||||
initThemeToggle();
|
||||
});
|
||||
|
||||
/**
|
||||
* Mobile Navigation Toggle
|
||||
*/
|
||||
function initMobileNav() {
|
||||
const mobileToggle = document.querySelector('[data-mobile-toggle]');
|
||||
const navigation = document.querySelector('[data-navigation]');
|
||||
|
||||
if (!mobileToggle || !navigation) return;
|
||||
|
||||
mobileToggle.addEventListener('click', () => {
|
||||
navigation.classList.toggle('open');
|
||||
mobileToggle.classList.toggle('active');
|
||||
|
||||
// Update aria-expanded
|
||||
const isOpen = navigation.classList.contains('open');
|
||||
mobileToggle.setAttribute('aria-expanded', isOpen);
|
||||
});
|
||||
|
||||
// Close menu when clicking outside
|
||||
document.addEventListener('click', (event) => {
|
||||
if (!mobileToggle.contains(event.target) && !navigation.contains(event.target)) {
|
||||
navigation.classList.remove('open');
|
||||
mobileToggle.classList.remove('active');
|
||||
mobileToggle.setAttribute('aria-expanded', 'false');
|
||||
}
|
||||
});
|
||||
|
||||
// Close menu when clicking a nav link
|
||||
navigation.querySelectorAll('.nav-link').forEach(link => {
|
||||
link.addEventListener('click', () => {
|
||||
navigation.classList.remove('open');
|
||||
mobileToggle.classList.remove('active');
|
||||
mobileToggle.setAttribute('aria-expanded', 'false');
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Smooth Scroll for Anchor Links
|
||||
*/
|
||||
function initSmoothScroll() {
|
||||
document.querySelectorAll('a[href^="#"]').forEach(anchor => {
|
||||
anchor.addEventListener('click', function(e) {
|
||||
const targetId = this.getAttribute('href');
|
||||
if (targetId === '#') return;
|
||||
|
||||
const targetElement = document.querySelector(targetId);
|
||||
if (!targetElement) return;
|
||||
|
||||
e.preventDefault();
|
||||
|
||||
const navHeight = document.querySelector('.nav-container')?.offsetHeight || 0;
|
||||
const targetPosition = targetElement.getBoundingClientRect().top + window.pageYOffset - navHeight - 24;
|
||||
|
||||
window.scrollTo({
|
||||
top: targetPosition,
|
||||
behavior: 'smooth'
|
||||
});
|
||||
|
||||
// Update URL without jumping
|
||||
history.pushState(null, null, targetId);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Copy Code Functionality
|
||||
*/
|
||||
function initCopyCode() {
|
||||
document.querySelectorAll('.card-code-block').forEach(block => {
|
||||
// Create copy button
|
||||
const copyBtn = document.createElement('button');
|
||||
copyBtn.className = 'copy-btn';
|
||||
copyBtn.innerHTML = '<i class="fa-regular fa-copy"></i>';
|
||||
copyBtn.setAttribute('aria-label', 'Copy code');
|
||||
copyBtn.setAttribute('title', 'Copy to clipboard');
|
||||
|
||||
// Style the button
|
||||
copyBtn.style.cssText = `
|
||||
position: absolute;
|
||||
top: 8px;
|
||||
right: 8px;
|
||||
padding: 6px 10px;
|
||||
background: rgba(255, 255, 255, 0.1);
|
||||
border: none;
|
||||
border-radius: 6px;
|
||||
color: #94a3b8;
|
||||
cursor: pointer;
|
||||
opacity: 0;
|
||||
transition: all 0.2s ease;
|
||||
font-size: 14px;
|
||||
`;
|
||||
|
||||
// Make parent relative for positioning
|
||||
block.style.position = 'relative';
|
||||
block.appendChild(copyBtn);
|
||||
|
||||
// Show/hide on hover
|
||||
block.addEventListener('mouseenter', () => {
|
||||
copyBtn.style.opacity = '1';
|
||||
});
|
||||
|
||||
block.addEventListener('mouseleave', () => {
|
||||
copyBtn.style.opacity = '0';
|
||||
});
|
||||
|
||||
// Copy functionality
|
||||
copyBtn.addEventListener('click', async () => {
|
||||
const code = block.querySelector('code');
|
||||
if (!code) return;
|
||||
|
||||
try {
|
||||
await navigator.clipboard.writeText(code.textContent);
|
||||
copyBtn.innerHTML = '<i class="fa-solid fa-check"></i>';
|
||||
copyBtn.style.color = '#34d399';
|
||||
|
||||
setTimeout(() => {
|
||||
copyBtn.innerHTML = '<i class="fa-regular fa-copy"></i>';
|
||||
copyBtn.style.color = '#94a3b8';
|
||||
}, 2000);
|
||||
} catch (err) {
|
||||
console.error('Failed to copy:', err);
|
||||
copyBtn.innerHTML = '<i class="fa-solid fa-xmark"></i>';
|
||||
copyBtn.style.color = '#f87171';
|
||||
|
||||
setTimeout(() => {
|
||||
copyBtn.innerHTML = '<i class="fa-regular fa-copy"></i>';
|
||||
copyBtn.style.color = '#94a3b8';
|
||||
}, 2000);
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Theme Toggle (Light/Dark)
|
||||
*/
|
||||
function initThemeToggle() {
|
||||
// Check for saved theme preference or default to dark
|
||||
const savedTheme = localStorage.getItem('theme') || 'dark';
|
||||
document.documentElement.className = `theme-${savedTheme}`;
|
||||
|
||||
// Create theme toggle button if it doesn't exist
|
||||
const existingToggle = document.querySelector('[data-theme-toggle]');
|
||||
if (existingToggle) {
|
||||
existingToggle.addEventListener('click', toggleTheme);
|
||||
updateThemeToggleIcon(existingToggle, savedTheme);
|
||||
}
|
||||
}
|
||||
|
||||
function toggleTheme() {
|
||||
const html = document.documentElement;
|
||||
const currentTheme = html.classList.contains('theme-dark') ? 'dark' : 'light';
|
||||
const newTheme = currentTheme === 'dark' ? 'light' : 'dark';
|
||||
|
||||
html.className = `theme-${newTheme}`;
|
||||
localStorage.setItem('theme', newTheme);
|
||||
|
||||
const toggle = document.querySelector('[data-theme-toggle]');
|
||||
if (toggle) {
|
||||
updateThemeToggleIcon(toggle, newTheme);
|
||||
}
|
||||
}
|
||||
|
||||
function updateThemeToggleIcon(toggle, theme) {
|
||||
const icon = toggle.querySelector('i');
|
||||
if (icon) {
|
||||
icon.className = theme === 'dark' ? 'fa-solid fa-sun' : 'fa-solid fa-moon';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Intersection Observer for Animation on Scroll
|
||||
*/
|
||||
function initScrollAnimations() {
|
||||
const observerOptions = {
|
||||
threshold: 0.1,
|
||||
rootMargin: '0px 0px -50px 0px'
|
||||
};
|
||||
|
||||
const observer = new IntersectionObserver((entries) => {
|
||||
entries.forEach(entry => {
|
||||
if (entry.isIntersecting) {
|
||||
entry.target.classList.add('visible');
|
||||
observer.unobserve(entry.target);
|
||||
}
|
||||
});
|
||||
}, observerOptions);
|
||||
|
||||
document.querySelectorAll('.agent-card, .command-card, .skill-card, .mcp-card, .stat-card').forEach(card => {
|
||||
card.style.opacity = '0';
|
||||
card.style.transform = 'translateY(20px)';
|
||||
card.style.transition = 'opacity 0.5s ease, transform 0.5s ease';
|
||||
observer.observe(card);
|
||||
});
|
||||
}
|
||||
|
||||
// Add visible class styles
|
||||
const style = document.createElement('style');
|
||||
style.textContent = `
|
||||
.agent-card.visible,
|
||||
.command-card.visible,
|
||||
.skill-card.visible,
|
||||
.mcp-card.visible,
|
||||
.stat-card.visible {
|
||||
opacity: 1 !important;
|
||||
transform: translateY(0) !important;
|
||||
}
|
||||
`;
|
||||
document.head.appendChild(style);
|
||||
|
||||
// Initialize scroll animations after a short delay
|
||||
setTimeout(initScrollAnimations, 100);
|
||||
@@ -1,649 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="theme-dark">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Agent Reference - Compounding Engineering</title>
|
||||
<meta content="Complete reference for all 23 specialized AI agents in 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" class="active">Agents (23)</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>
|
||||
<li><a href="#review-agents">Review (10)</a></li>
|
||||
<li><a href="#research-agents">Research (4)</a></li>
|
||||
<li><a href="#workflow-agents">Workflow (5)</a></li>
|
||||
<li><a href="#design-agents">Design (3)</a></li>
|
||||
<li><a href="#docs-agents">Docs (1)</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>Agents</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-users-gear color-accent"></i> Agent Reference</h1>
|
||||
<p class="lead">
|
||||
Think of agents as your expert teammates who never sleep. You've got 23 specialists here—each one obsessed with a single domain. Call them individually when you need focused expertise, or orchestrate them together for multi-angle analysis. They're opinionated, they're fast, and they remember your codebase better than you do.
|
||||
</p>
|
||||
|
||||
<div class="usage-box">
|
||||
<h3>How to Use Agents</h3>
|
||||
<div class="card-code-block">
|
||||
<pre><code># Basic invocation
|
||||
claude agent [agent-name]
|
||||
|
||||
# With a specific message
|
||||
claude agent [agent-name] "Your message here"
|
||||
|
||||
# Examples
|
||||
claude agent kieran-rails-reviewer
|
||||
claude agent security-sentinel "Audit the payment flow"</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Review Agents -->
|
||||
<section id="review-agents">
|
||||
<h2><i class="fa-solid fa-code-pull-request"></i> Review Agents (10)</h2>
|
||||
<p>Your code review dream team. These agents catch what humans miss at 2am—security holes, performance cliffs, architectural drift, and those "it works but I hate it" moments. They're picky. They disagree with each other. That's the point.</p>
|
||||
|
||||
<div class="agent-detail" id="kieran-rails-reviewer">
|
||||
<div class="agent-detail-header">
|
||||
<h3>kieran-rails-reviewer</h3>
|
||||
<span class="agent-badge">Rails</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Your senior Rails developer who's seen too many "clever" solutions fail in production. Obsessed with code that's boring, predictable, and maintainable. Strict on existing code (because touching it risks everything), pragmatic on new isolated features (because shipping matters). If you've ever thought "this works but feels wrong," this reviewer will tell you why.
|
||||
</p>
|
||||
<h4>Key Principles</h4>
|
||||
<ul>
|
||||
<li><strong>Existing Code Modifications</strong> - Very strict. Added complexity needs strong justification.</li>
|
||||
<li><strong>New Code</strong> - Pragmatic. If it's isolated and works, it's acceptable.</li>
|
||||
<li><strong>Turbo Streams</strong> - Simple turbo streams MUST be inline arrays in controllers.</li>
|
||||
<li><strong>Testing as Quality</strong> - Hard-to-test code = poor structure that needs refactoring.</li>
|
||||
<li><strong>Naming (5-Second Rule)</strong> - Must understand what a view/component does in 5 seconds from its name.</li>
|
||||
<li><strong>Namespacing</strong> - Always use <code>class Module::ClassName</code> pattern.</li>
|
||||
<li><strong>Duplication > Complexity</strong> - Simple duplicated code is better than complex DRY abstractions.</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent kieran-rails-reviewer "Review the UserController"</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="dhh-rails-reviewer">
|
||||
<div class="agent-detail-header">
|
||||
<h3>dhh-rails-reviewer</h3>
|
||||
<span class="agent-badge">Rails</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
What if DHH reviewed your Rails PR? He'd ask why you're building React inside Rails, why you need six layers of abstraction for a form, and whether you've forgotten that Rails already solved this problem. This agent channels that energy—blunt, opinionated, allergic to complexity.
|
||||
</p>
|
||||
<h4>Key Focus Areas</h4>
|
||||
<ul>
|
||||
<li>Identifies deviations from Rails conventions</li>
|
||||
<li>Spots JavaScript framework patterns infiltrating Rails</li>
|
||||
<li>Tears apart unnecessary abstractions</li>
|
||||
<li>Challenges overengineering and microservices mentality</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent dhh-rails-reviewer</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="kieran-python-reviewer">
|
||||
<div class="agent-detail-header">
|
||||
<h3>kieran-python-reviewer</h3>
|
||||
<span class="agent-badge">Python</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Your Pythonic perfectionist who believes type hints aren't optional and <code>dict.get()</code> beats try/except KeyError. Expects modern Python 3.10+ patterns—no legacy syntax, no <code>typing.List</code> when <code>list</code> works natively. If your code looks like Java translated to Python, prepare for rewrites.
|
||||
</p>
|
||||
<h4>Key Focus Areas</h4>
|
||||
<ul>
|
||||
<li>Type hints for all functions</li>
|
||||
<li>Pythonic patterns and idioms</li>
|
||||
<li>Modern Python syntax</li>
|
||||
<li>Import organization</li>
|
||||
<li>Module extraction signals</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent kieran-python-reviewer</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="kieran-typescript-reviewer">
|
||||
<div class="agent-detail-header">
|
||||
<h3>kieran-typescript-reviewer</h3>
|
||||
<span class="agent-badge">TypeScript</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
TypeScript's type system is a gift—don't throw it away with <code>any</code>. This reviewer treats <code>any</code> like a code smell that needs justification. Expects proper types, clean imports, and code that doesn't need comments because the types explain everything. You added TypeScript for safety; this agent makes sure you actually get it.
|
||||
</p>
|
||||
<h4>Key Focus Areas</h4>
|
||||
<ul>
|
||||
<li>No <code>any</code> without justification</li>
|
||||
<li>Component/module extraction signals</li>
|
||||
<li>Import organization</li>
|
||||
<li>Modern TypeScript patterns</li>
|
||||
<li>Testability assessment</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent kieran-typescript-reviewer</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="security-sentinel">
|
||||
<div class="agent-detail-header">
|
||||
<h3>security-sentinel</h3>
|
||||
<span class="agent-badge critical">Security</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Security vulnerabilities hide in boring code—the "just grab the user ID from params" line that ships a privilege escalation bug to production. This agent thinks like an attacker: SQL injection, XSS, auth bypass, leaked secrets. Run it before touching authentication, payments, or anything with PII. Your users' data depends on paranoia.
|
||||
</p>
|
||||
<h4>Security Checks</h4>
|
||||
<ul>
|
||||
<li>Input validation analysis</li>
|
||||
<li>SQL injection risk assessment</li>
|
||||
<li>XSS vulnerability detection</li>
|
||||
<li>Authentication/authorization audit</li>
|
||||
<li>Sensitive data exposure scanning</li>
|
||||
<li>OWASP Top 10 compliance</li>
|
||||
<li>Hardcoded secrets search</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent security-sentinel "Audit the payment flow"</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="performance-oracle">
|
||||
<div class="agent-detail-header">
|
||||
<h3>performance-oracle</h3>
|
||||
<span class="agent-badge">Performance</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Your code works fine with 10 users. What happens at 10,000? This agent time-travels to your future scaling problems—N+1 queries that murder your database, O(n²) algorithms hiding in loops, missing indexes, memory leaks. It thinks in Big O notation and asks uncomfortable questions about what breaks first when traffic spikes.
|
||||
</p>
|
||||
<h4>Analysis Areas</h4>
|
||||
<ul>
|
||||
<li>Algorithmic complexity (Big O notation)</li>
|
||||
<li>N+1 query pattern detection</li>
|
||||
<li>Proper index usage verification</li>
|
||||
<li>Memory management review</li>
|
||||
<li>Caching opportunity identification</li>
|
||||
<li>Network usage optimization</li>
|
||||
<li>Frontend bundle impact</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent performance-oracle</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="architecture-strategist">
|
||||
<div class="agent-detail-header">
|
||||
<h3>architecture-strategist</h3>
|
||||
<span class="agent-badge">Architecture</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Every "small change" either reinforces your architecture or starts eroding it. This agent zooms out to see if your fix actually fits the system's design—or if you're bolting duct tape onto a crumbling foundation. It speaks SOLID principles, microservice boundaries, and API contracts. Call it when you're about to make a change that "feels weird."
|
||||
</p>
|
||||
<h4>Analysis Areas</h4>
|
||||
<ul>
|
||||
<li>Overall system structure understanding</li>
|
||||
<li>Change context within architecture</li>
|
||||
<li>Architectural violation identification</li>
|
||||
<li>SOLID principles compliance</li>
|
||||
<li>Microservice boundary assessment</li>
|
||||
<li>API contract evaluation</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent architecture-strategist</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="data-integrity-guardian">
|
||||
<div class="agent-detail-header">
|
||||
<h3>data-integrity-guardian</h3>
|
||||
<span class="agent-badge critical">Data</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Migrations can't be rolled back once they're run on production. This agent is your last line of defense before you accidentally drop a column with user data, create a race condition in transactions, or violate GDPR. It obsesses over referential integrity, rollback safety, and data constraints. Your database is forever; migrations should be paranoid.
|
||||
</p>
|
||||
<h4>Review Areas</h4>
|
||||
<ul>
|
||||
<li>Migration safety and reversibility</li>
|
||||
<li>Data constraint validation</li>
|
||||
<li>Transaction boundary review</li>
|
||||
<li>Referential integrity preservation</li>
|
||||
<li>Privacy compliance (GDPR, CCPA)</li>
|
||||
<li>Data corruption scenario checking</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent data-integrity-guardian</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="pattern-recognition-specialist">
|
||||
<div class="agent-detail-header">
|
||||
<h3>pattern-recognition-specialist</h3>
|
||||
<span class="agent-badge">Patterns</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Patterns tell stories—Factory, Observer, God Object, Copy-Paste Programming. This agent reads your code like an archaeologist reading artifacts. It spots the good patterns (intentional design), the anti-patterns (accumulated tech debt), and the duplicated blocks you swore you'd refactor later. Runs tools like jscpd because humans miss repetition that machines catch instantly.
|
||||
</p>
|
||||
<h4>Detection Areas</h4>
|
||||
<ul>
|
||||
<li>Design patterns (Factory, Singleton, Observer, etc.)</li>
|
||||
<li>Anti-patterns and code smells</li>
|
||||
<li>TODO/FIXME comments</li>
|
||||
<li>God objects and circular dependencies</li>
|
||||
<li>Naming consistency</li>
|
||||
<li>Code duplication</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent pattern-recognition-specialist</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="code-simplicity-reviewer">
|
||||
<div class="agent-detail-header">
|
||||
<h3>code-simplicity-reviewer</h3>
|
||||
<span class="agent-badge">Quality</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Simplicity is violent discipline. This agent asks "do you actually need this?" about every line, every abstraction, every dependency. YAGNI isn't a suggestion—it's the law. Your 200-line feature with three layers of indirection? This agent will show you the 50-line version that does the same thing. Complexity is a liability; simplicity compounds.
|
||||
</p>
|
||||
<h4>Simplification Checks</h4>
|
||||
<ul>
|
||||
<li>Analyze every line for necessity</li>
|
||||
<li>Simplify complex logic</li>
|
||||
<li>Remove redundancy and duplication</li>
|
||||
<li>Challenge abstractions</li>
|
||||
<li>Optimize for readability</li>
|
||||
<li>Eliminate premature generalization</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent code-simplicity-reviewer</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Research Agents -->
|
||||
<section id="research-agents">
|
||||
<h2><i class="fa-solid fa-microscope"></i> Research Agents (4)</h2>
|
||||
<p>Stop guessing. These agents dig through documentation, GitHub repos, git history, and real-world examples to give you answers backed by evidence. They read faster than you, remember more than you, and synthesize patterns you'd miss. Perfect for "how should I actually do this?" questions.</p>
|
||||
|
||||
<div class="agent-detail" id="framework-docs-researcher">
|
||||
<div class="agent-detail-header">
|
||||
<h3>framework-docs-researcher</h3>
|
||||
<span class="agent-badge">Research</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Official docs are scattered. GitHub examples are inconsistent. Deprecations hide in changelogs. This agent pulls it all together—docs, source code, version constraints, real-world examples. Ask "how do I use Hotwire Turbo?" and get back patterns that actually work in production, not toy tutorials.
|
||||
</p>
|
||||
<h4>Capabilities</h4>
|
||||
<ul>
|
||||
<li>Fetch official framework and library documentation</li>
|
||||
<li>Identify version-specific constraints and deprecations</li>
|
||||
<li>Search GitHub for real-world usage examples</li>
|
||||
<li>Analyze gem/library source code using <code>bundle show</code></li>
|
||||
<li>Synthesize findings with practical examples</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent framework-docs-researcher "Research Hotwire Turbo patterns"</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="best-practices-researcher">
|
||||
<div class="agent-detail-header">
|
||||
<h3>best-practices-researcher</h3>
|
||||
<span class="agent-badge">Research</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
"Best practices" are everywhere and contradictory. This agent cuts through the noise by evaluating sources (official docs, trusted blogs, real GitHub repos), checking recency, and synthesizing actionable guidance. You get code templates, patterns that scale, and answers you can trust—not StackOverflow copy-paste roulette.
|
||||
</p>
|
||||
<h4>Capabilities</h4>
|
||||
<ul>
|
||||
<li>Leverage multiple sources (Context7 MCP, web search, GitHub)</li>
|
||||
<li>Evaluate information quality and recency</li>
|
||||
<li>Synthesize into actionable guidance</li>
|
||||
<li>Provide code examples and templates</li>
|
||||
<li>Research issue templates and community engagement</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent best-practices-researcher "Find pagination patterns"</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="git-history-analyzer">
|
||||
<div class="agent-detail-header">
|
||||
<h3>git-history-analyzer</h3>
|
||||
<span class="agent-badge">Git</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Your codebase has a history—decisions, patterns, mistakes. This agent does archaeology with git tools: file evolution, blame analysis, contributor expertise mapping. Ask "why does this code exist?" and get the commit that explains it. Spot patterns in how bugs appear. Understand the design decisions buried in history.
|
||||
</p>
|
||||
<h4>Analysis Techniques</h4>
|
||||
<ul>
|
||||
<li>Trace file evolution using <code>git log --follow</code></li>
|
||||
<li>Determine code origins using <code>git blame -w -C -C -C</code></li>
|
||||
<li>Identify patterns from commit history</li>
|
||||
<li>Map key contributors and expertise areas</li>
|
||||
<li>Extract historical patterns of issues and fixes</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent git-history-analyzer "Analyze changes to User model"</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="repo-research-analyst">
|
||||
<div class="agent-detail-header">
|
||||
<h3>repo-research-analyst</h3>
|
||||
<span class="agent-badge">Research</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Every repo has conventions—some documented, most tribal knowledge. This agent reads ARCHITECTURE.md, issue templates, PR patterns, and actual code to reverse-engineer the standards. Perfect for joining a new project or ensuring your PR matches the team's implicit style. Finds the rules nobody wrote down.
|
||||
</p>
|
||||
<h4>Analysis Areas</h4>
|
||||
<ul>
|
||||
<li>Architecture and documentation files (ARCHITECTURE.md, README.md, CLAUDE.md)</li>
|
||||
<li>GitHub issues for patterns and conventions</li>
|
||||
<li>Issue/PR templates and guidelines</li>
|
||||
<li>Implementation patterns using ast-grep or rg</li>
|
||||
<li>Project-specific conventions</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent repo-research-analyst</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Workflow Agents -->
|
||||
<section id="workflow-agents">
|
||||
<h2><i class="fa-solid fa-gears"></i> Workflow Agents (5)</h2>
|
||||
<p>Tedious work you hate doing. These agents handle the grind—reproducing bugs, resolving PR comments, running linters, analyzing specs. They're fast, they don't complain, and they free you up to solve interesting problems instead of mechanical ones.</p>
|
||||
|
||||
<div class="agent-detail" id="bug-reproduction-validator">
|
||||
<div class="agent-detail-header">
|
||||
<h3>bug-reproduction-validator</h3>
|
||||
<span class="agent-badge">Bugs</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Half of bug reports aren't bugs—they're user errors, environment issues, or misunderstood features. This agent systematically reproduces the reported behavior, classifies what it finds (Confirmed, Can't Reproduce, Not a Bug, etc.), and assesses severity. Saves you from chasing ghosts or missing real issues.
|
||||
</p>
|
||||
<h4>Classification Types</h4>
|
||||
<ul>
|
||||
<li><strong>Confirmed</strong> - Bug reproduced successfully</li>
|
||||
<li><strong>Cannot Reproduce</strong> - Unable to reproduce</li>
|
||||
<li><strong>Not a Bug</strong> - Expected behavior</li>
|
||||
<li><strong>Environmental</strong> - Environment-specific issue</li>
|
||||
<li><strong>Data</strong> - Data-related issue</li>
|
||||
<li><strong>User Error</strong> - User misunderstanding</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent bug-reproduction-validator</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="pr-comment-resolver">
|
||||
<div class="agent-detail-header">
|
||||
<h3>pr-comment-resolver</h3>
|
||||
<span class="agent-badge">PR</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Code review comments pile up. This agent reads them, plans fixes, implements changes, and reports back what it did. It doesn't argue with reviewers or skip hard feedback—it just resolves the work systematically. Great for burning through a dozen "change this variable name" comments in seconds.
|
||||
</p>
|
||||
<h4>Workflow</h4>
|
||||
<ul>
|
||||
<li>Analyze code review comments</li>
|
||||
<li>Plan the resolution before implementation</li>
|
||||
<li>Implement requested modifications</li>
|
||||
<li>Verify resolution doesn't break functionality</li>
|
||||
<li>Provide clear resolution reports</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent pr-comment-resolver</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="lint">
|
||||
<div class="agent-detail-header">
|
||||
<h3>lint</h3>
|
||||
<span class="agent-badge">Quality</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Linters are pedantic robots that enforce consistency. This agent runs StandardRB, ERBLint, and Brakeman for you—checking Ruby style, ERB templates, and security issues. It's fast (uses the Haiku model) and catches the formatting noise before CI does.
|
||||
</p>
|
||||
<h4>Tools Run</h4>
|
||||
<ul>
|
||||
<li><code>bundle exec standardrb</code> - Ruby file checking/fixing</li>
|
||||
<li><code>bundle exec erblint --lint-all</code> - ERB templates</li>
|
||||
<li><code>bin/brakeman</code> - Security scanning</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent lint</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="spec-flow-analyzer">
|
||||
<div class="agent-detail-header">
|
||||
<h3>spec-flow-analyzer</h3>
|
||||
<span class="agent-badge">Testing</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Specs always have gaps—edge cases nobody thought about, ambiguous requirements, missing error states. This agent maps all possible user flows, identifies what's unclear or missing, and generates the questions you need to ask stakeholders. Runs before you code to avoid building the wrong thing.
|
||||
</p>
|
||||
<h4>Analysis Areas</h4>
|
||||
<ul>
|
||||
<li>Map all possible user flows and permutations</li>
|
||||
<li>Identify gaps, ambiguities, and missing specifications</li>
|
||||
<li>Consider different user types, roles, permissions</li>
|
||||
<li>Analyze error states and edge cases</li>
|
||||
<li>Generate critical questions requiring clarification</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent spec-flow-analyzer</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="every-style-editor">
|
||||
<div class="agent-detail-header">
|
||||
<h3>every-style-editor</h3>
|
||||
<span class="agent-badge">Content</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Style guides are arbitrary rules that make writing consistent. This agent enforces Every's particular quirks—title case in headlines, no overused filler words ("actually," "very"), active voice, Oxford commas. It's a line-by-line grammar cop for content that needs to match the brand.
|
||||
</p>
|
||||
<h4>Style Checks</h4>
|
||||
<ul>
|
||||
<li>Title case in headlines, sentence case elsewhere</li>
|
||||
<li>Company singular/plural usage</li>
|
||||
<li>Remove overused words (actually, very, just)</li>
|
||||
<li>Enforce active voice</li>
|
||||
<li>Apply formatting rules (Oxford commas, em dashes)</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent every-style-editor</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Design Agents -->
|
||||
<section id="design-agents">
|
||||
<h2><i class="fa-solid fa-palette"></i> Design Agents (3)</h2>
|
||||
<p>Design is iteration. These agents take screenshots, compare them to Figma, make targeted improvements, and repeat. They fix spacing, alignment, colors, typography—the visual details that compound into polish. Perfect for closing the gap between "it works" and "it looks right."</p>
|
||||
|
||||
<div class="agent-detail" id="design-iterator">
|
||||
<div class="agent-detail-header">
|
||||
<h3>design-iterator</h3>
|
||||
<span class="agent-badge">Design</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Design doesn't happen in one pass. This agent runs a loop: screenshot the UI, analyze what's off (spacing, colors, alignment), implement 3-5 targeted fixes, repeat. Run it for 10 iterations and watch rough interfaces transform into polished designs through systematic refinement.
|
||||
</p>
|
||||
<h4>Process</h4>
|
||||
<ul>
|
||||
<li>Take focused screenshots of target elements</li>
|
||||
<li>Analyze current state and identify 3-5 improvements</li>
|
||||
<li>Implement targeted CSS/design changes</li>
|
||||
<li>Document changes made</li>
|
||||
<li>Repeat for specified iterations (default 10)</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent design-iterator</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="figma-design-sync">
|
||||
<div class="agent-detail-header">
|
||||
<h3>figma-design-sync</h3>
|
||||
<span class="agent-badge">Figma</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Designers hand you a Figma file. You build it. Then: "the spacing is wrong, the font is off, the colors don't match." This agent compares your implementation to the Figma spec, identifies every visual discrepancy, and fixes them automatically. Designers stay happy. You stay sane.
|
||||
</p>
|
||||
<h4>Workflow</h4>
|
||||
<ul>
|
||||
<li>Extract design specifications from Figma</li>
|
||||
<li>Capture implementation screenshots</li>
|
||||
<li>Conduct systematic visual comparison</li>
|
||||
<li>Make precise code changes to fix discrepancies</li>
|
||||
<li>Verify implementation matches design</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent figma-design-sync</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="agent-detail" id="design-implementation-reviewer">
|
||||
<div class="agent-detail-header">
|
||||
<h3>design-implementation-reviewer</h3>
|
||||
<span class="agent-badge">Review</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Before you ship UI changes, run this agent. It compares your implementation against Figma at a pixel level—layouts, typography, colors, spacing, responsive behavior. Uses the Opus model for detailed visual analysis. Catches the "close enough" mistakes that users notice but you don't.
|
||||
</p>
|
||||
<h4>Comparison Areas</h4>
|
||||
<ul>
|
||||
<li>Layouts and structure</li>
|
||||
<li>Typography (fonts, sizes, weights)</li>
|
||||
<li>Colors and themes</li>
|
||||
<li>Spacing and alignment</li>
|
||||
<li>Different viewport sizes</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent design-implementation-reviewer</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Docs Agents -->
|
||||
<section id="docs-agents">
|
||||
<h2><i class="fa-solid fa-file-lines"></i> Documentation Agent (1)</h2>
|
||||
|
||||
<div class="agent-detail" id="ankane-readme-writer">
|
||||
<div class="agent-detail-header">
|
||||
<h3>ankane-readme-writer</h3>
|
||||
<span class="agent-badge">Docs</span>
|
||||
</div>
|
||||
<p class="agent-detail-description">
|
||||
Andrew Kane writes READMEs that are models of clarity—concise, scannable, zero fluff. This agent generates gem documentation in that style: 15 words max per sentence, imperative voice, single-purpose code examples. If your README rambles, this agent will fix it.
|
||||
</p>
|
||||
<h4>Section Order</h4>
|
||||
<ol>
|
||||
<li>Header (title + description)</li>
|
||||
<li>Installation</li>
|
||||
<li>Quick Start</li>
|
||||
<li>Usage</li>
|
||||
<li>Options</li>
|
||||
<li>Upgrading</li>
|
||||
<li>Contributing</li>
|
||||
<li>License</li>
|
||||
</ol>
|
||||
<h4>Style Guidelines</h4>
|
||||
<ul>
|
||||
<li>Imperative voice throughout</li>
|
||||
<li>15 words max per sentence</li>
|
||||
<li>Single-purpose code fences</li>
|
||||
<li>Up to 4 badges maximum</li>
|
||||
<li>No HTML comments</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude agent ankane-readme-writer</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Navigation -->
|
||||
<nav class="docs-nav-footer">
|
||||
<a href="getting-started.html" class="nav-prev">
|
||||
<span class="nav-label">Previous</span>
|
||||
<span class="nav-title"><i class="fa-solid fa-arrow-left"></i> Getting Started</span>
|
||||
</a>
|
||||
<a href="commands.html" class="nav-next">
|
||||
<span class="nav-label">Next</span>
|
||||
<span class="nav-title">Commands <i class="fa-solid fa-arrow-right"></i></span>
|
||||
</a>
|
||||
</nav>
|
||||
</article>
|
||||
</main>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
document.querySelector('[data-sidebar-toggle]')?.addEventListener('click', () => {
|
||||
document.querySelector('.docs-sidebar').classList.toggle('open');
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
@@ -1,534 +0,0 @@
|
||||
<!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 (23)</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 (two)</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.32.2">v2.32.2</a></li>
|
||||
<li><a href="#v2.32.1">v2.32.1</a></li>
|
||||
<li><a href="#v2.6.0">v2.6.0</a></li>
|
||||
<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 compound-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.32.2 -->
|
||||
<section id="v2.32.2" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v2.32.2</h2>
|
||||
<span class="version-date">2026-02-12</span>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category changed">
|
||||
<h3><i class="fa-solid fa-arrows-rotate"></i> Changed</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<strong><code>/release-docs</code> command moved from plugin to local <code>.claude/commands/</code></strong> -
|
||||
This is a repository maintenance command and should not be distributed to users. Command count reduced from 24 to 23.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Version 2.32.1 -->
|
||||
<section id="v2.32.1" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v2.32.1</h2>
|
||||
<span class="version-date">2026-02-12</span>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category changed">
|
||||
<h3><i class="fa-solid fa-arrows-rotate"></i> Changed</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<strong><code>/workflows:review</code> command</strong> - Added <code>learnings-researcher</code>
|
||||
agent to the parallel review phase. The review now searches <code>docs/solutions/</code> for past
|
||||
issues related to the PR's modules and patterns, surfacing "Known Pattern" findings during synthesis.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Version 2.6.0 -->
|
||||
<section id="v2.6.0" class="version-section">
|
||||
<div class="version-header">
|
||||
<h2>v2.6.0</h2>
|
||||
<span class="version-date">2024-11-26</span>
|
||||
</div>
|
||||
|
||||
<div class="changelog-category removed">
|
||||
<h3><i class="fa-solid fa-minus"></i> Removed</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<strong><code>feedback-codifier</code> agent</strong> - Removed from workflow agents.
|
||||
Agent count reduced from 24 to 23.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- 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
|
||||
compound-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/compound-engineering-plugin 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 more than 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 (seven)</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 (nine)</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>/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> (four agents) - Documentation, patterns, history analysis</li>
|
||||
<li><code>design/</code> (three agents) - UI/design review and iteration</li>
|
||||
<li><code>workflow/</code> (six agents) - PR resolution, bug validation, linting</li>
|
||||
<li><code>docs/</code> (one 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 compound-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 (five)</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 (four)</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 (four)</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 (three)</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>Six 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>
|
||||
@@ -1,523 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="theme-dark">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Command Reference - Compounding Engineering</title>
|
||||
<meta content="Complete reference for all 16 slash commands in 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 (23)</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 (two)</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>
|
||||
<li><a href="#workflow-commands">Workflow (four)</a></li>
|
||||
<li><a href="#utility-commands">Utility (12)</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>Commands</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-terminal color-accent"></i> Command Reference</h1>
|
||||
<p class="lead">
|
||||
Here's the thing about slash commands: they're workflows you'd spend 20 minutes doing manually, compressed into one line. Type <code>/plan</code> and watch three agents launch in parallel to research your codebase while you grab coffee. That's the point—automation that actually saves time, not busywork dressed up as productivity.
|
||||
</p>
|
||||
|
||||
<!-- Workflow Commands -->
|
||||
<section id="workflow-commands">
|
||||
<h2><i class="fa-solid fa-arrows-spin"></i> Workflow Commands (four)</h2>
|
||||
<p>These are the big four: Plan your feature, Review your code, Work through the implementation, and Codify what you learned. Every professional developer does this cycle—these commands just make you faster at it.</p>
|
||||
|
||||
<div class="command-detail" id="workflows-plan">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/plan</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
You've got a feature request and a blank page. This command turns "we need OAuth" into a structured plan that actually tells you what to build—researched, reviewed, and ready to execute.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[feature description, bug report, or improvement idea]</code></p>
|
||||
<h4>Workflow</h4>
|
||||
<ol>
|
||||
<li><strong>Repository Research (Parallel)</strong> - Launch three agents simultaneously:
|
||||
<ul>
|
||||
<li><code>repo-research-analyst</code> - Project patterns</li>
|
||||
<li><code>best-practices-researcher</code> - Industry standards</li>
|
||||
<li><code>framework-docs-researcher</code> - Framework documentation</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>SpecFlow Analysis</strong> - Run <code>spec-flow-analyzer</code> for user flows</li>
|
||||
<li><strong>Choose Detail Level</strong>:
|
||||
<ul>
|
||||
<li><strong>MINIMAL</strong> - Simple bugs/small improvements</li>
|
||||
<li><strong>MORE</strong> - Standard features</li>
|
||||
<li><strong>A LOT</strong> - Major features with phases</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>Write Plan</strong> - Save as <code>plans/<issue_title>.md</code></li>
|
||||
<li><strong>Review</strong> - Call <code>/plan_review</code> for multi-agent feedback</li>
|
||||
</ol>
|
||||
<div class="callout callout-info">
|
||||
<div class="callout-icon"><i class="fa-solid fa-circle-info"></i></div>
|
||||
<div class="callout-content">
|
||||
<p>This command does NOT write code. It only researches and creates the plan.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/plan Add OAuth integration for third-party auth
|
||||
/plan Fix N+1 query in user dashboard</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="command-detail" id="workflows-review">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/review</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
Twelve specialized reviewers examine your PR in parallel—security, performance, architecture, patterns. It's like code review by committee, except the committee finishes in two minutes instead of two days.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[PR number, GitHub URL, branch name, or "latest"]</code></p>
|
||||
<h4>Workflow</h4>
|
||||
<ol>
|
||||
<li><strong>Setup</strong> - Detect review target, optionally use git-worktree for isolation</li>
|
||||
<li><strong>Launch 12 Parallel Review Agents</strong>:
|
||||
<ul>
|
||||
<li><code>kieran-rails-reviewer</code>, <code>dhh-rails-reviewer</code></li>
|
||||
<li><code>security-sentinel</code>, <code>performance-oracle</code></li>
|
||||
<li><code>architecture-strategist</code>, <code>data-integrity-guardian</code></li>
|
||||
<li><code>pattern-recognition-specialist</code>, <code>git-history-analyzer</code></li>
|
||||
<li>And more...</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>Ultra-Thinking Analysis</strong> - Stakeholder perspectives, scenario exploration</li>
|
||||
<li><strong>Simplification Review</strong> - Run <code>code-simplicity-reviewer</code></li>
|
||||
<li><strong>Synthesize Findings</strong> - Categorize by severity (P1/P2/P3)</li>
|
||||
<li><strong>Create Todo Files</strong> - Using file-todos skill for all findings</li>
|
||||
</ol>
|
||||
<div class="callout callout-warning">
|
||||
<div class="callout-icon"><i class="fa-solid fa-triangle-exclamation"></i></div>
|
||||
<div class="callout-content">
|
||||
<p><strong>P1 (Critical) findings BLOCK MERGE.</strong> Address these before merging.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/review 42
|
||||
/review https://github.com/owner/repo/pull/42
|
||||
/review feature-branch-name
|
||||
/review latest</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="command-detail" id="workflows-work">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/work</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
Point this at a plan file and watch it execute—reading requirements, setting up environment, running tests, creating commits, opening PRs. It's the "just build the thing" button you wish you always had.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[plan file, specification, or todo file path]</code></p>
|
||||
<h4>Phases</h4>
|
||||
<ol>
|
||||
<li><strong>Quick Start</strong>
|
||||
<ul>
|
||||
<li>Read plan & clarify requirements</li>
|
||||
<li>Setup environment (live or worktree)</li>
|
||||
<li>Create TodoWrite task list</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>Execute</strong>
|
||||
<ul>
|
||||
<li>Task execution loop with progress tracking</li>
|
||||
<li>Follow existing patterns</li>
|
||||
<li>Test continuously</li>
|
||||
<li>Figma sync if applicable</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>Quality Check</strong>
|
||||
<ul>
|
||||
<li>Run test suite</li>
|
||||
<li>Run linting</li>
|
||||
<li>Optional reviewer agents for complex changes</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>Ship It</strong>
|
||||
<ul>
|
||||
<li>Create commit with conventional format</li>
|
||||
<li>Create pull request</li>
|
||||
<li>Notify with summary</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ol>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/work plans/user-authentication.md
|
||||
/work todos/042-ready-p1-performance-issue.md</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="command-detail" id="workflows-compound">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/compound</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
Just fixed a gnarly bug? This captures the solution before you forget it. Seven agents analyze what you did, why it worked, and how to prevent it next time. Each documented solution compounds your team's knowledge.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[optional: brief context about the fix]</code></p>
|
||||
<h4>Workflow</h4>
|
||||
<ol>
|
||||
<li><strong>Preconditions</strong> - Verify problem is solved and verified working</li>
|
||||
<li><strong>Launch seven parallel subagents</strong>:
|
||||
<ul>
|
||||
<li>Context Analyzer - Extract YAML frontmatter skeleton</li>
|
||||
<li>Solution Extractor - Identify root cause and solution</li>
|
||||
<li>Related Docs Finder - Find cross-references</li>
|
||||
<li>Prevention Strategist - Develop prevention strategies</li>
|
||||
<li>Category Classifier - Determine docs category</li>
|
||||
<li>Documentation Writer - Create the file</li>
|
||||
<li>Optional Specialized Agent - Based on problem type</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>Create Documentation</strong> - File in <code>docs/solutions/[category]/</code></li>
|
||||
</ol>
|
||||
<h4>Auto-Triggers</h4>
|
||||
<p>Phrases: "that worked", "it's fixed", "working now", "problem solved"</p>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/compound
|
||||
/compound N+1 query optimization</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Utility Commands -->
|
||||
<section id="utility-commands">
|
||||
<h2><i class="fa-solid fa-wrench"></i> Utility Commands (12)</h2>
|
||||
<p>The supporting cast—commands that do one specific thing really well. Generate changelogs, resolve todos in parallel, triage findings, create new commands. The utilities you reach for daily.</p>
|
||||
|
||||
<div class="command-detail" id="changelog">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/changelog</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
Turn your git history into a changelog people actually want to read. Breaking changes at the top, fun facts at the bottom, everything organized by what matters to your users.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[optional: daily|weekly, or time period in days]</code></p>
|
||||
<h4>Output Sections</h4>
|
||||
<ul>
|
||||
<li>Breaking Changes (top priority)</li>
|
||||
<li>New Features</li>
|
||||
<li>Bug Fixes</li>
|
||||
<li>Other Improvements</li>
|
||||
<li>Shoutouts</li>
|
||||
<li>Fun Fact</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/changelog daily
|
||||
/changelog weekly
|
||||
/changelog 7</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="command-detail" id="create-agent-skill">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/create-agent-skill</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
Need a new skill? This walks you through creating one that actually works—proper frontmatter, clear documentation, all the conventions baked in. Think of it as scaffolding for skills.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[skill description or requirements]</code></p>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/create-agent-skill PDF processing for document analysis
|
||||
/create-agent-skill Web scraping with error handling</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="command-detail" id="generate-command">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/generate_command</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
Same idea, but for commands instead of skills. Tell it what workflow you're tired of doing manually, and it generates a proper slash command with all the right patterns.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[command purpose and requirements]</code></p>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/generate_command Security audit for codebase
|
||||
/generate_command Automated performance testing</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="command-detail" id="heal-skill">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/heal-skill</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
Skills drift—APIs change, URLs break, parameters get renamed. When a skill stops working, this figures out what's wrong and fixes the documentation. You approve the changes before anything commits.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[optional: specific issue to fix]</code></p>
|
||||
<h4>Approval Options</h4>
|
||||
<ol>
|
||||
<li>Apply and commit</li>
|
||||
<li>Apply without commit</li>
|
||||
<li>Revise changes</li>
|
||||
<li>Cancel</li>
|
||||
</ol>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/heal-skill API endpoint URL changed
|
||||
/heal-skill parameter validation error</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="command-detail" id="plan-review">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/plan_review</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
Before you execute a plan, have three reviewers tear it apart—Rails conventions, best practices, simplicity. Better to find the problems in the plan than in production.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[plan file path or plan content]</code></p>
|
||||
<h4>Review Agents</h4>
|
||||
<ul>
|
||||
<li><code>dhh-rails-reviewer</code> - Rails conventions</li>
|
||||
<li><code>kieran-rails-reviewer</code> - Rails best practices</li>
|
||||
<li><code>code-simplicity-reviewer</code> - Simplicity and clarity</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/plan_review plans/user-authentication.md</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="command-detail" id="report-bug">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/report-bug</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
Something broken? This collects all the context—what broke, what you expected, error messages, environment—and files a proper bug report. No more "it doesn't work" issues.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[optional: brief description of the bug]</code></p>
|
||||
<h4>Information Collected</h4>
|
||||
<ul>
|
||||
<li>Bug category (Agent/Command/Skill/MCP/Installation)</li>
|
||||
<li>Specific component name</li>
|
||||
<li>Actual vs expected behavior</li>
|
||||
<li>Steps to reproduce</li>
|
||||
<li>Error messages</li>
|
||||
<li>Environment info (auto-gathered)</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/report-bug Agent not working
|
||||
/report-bug Command failing with timeout</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="command-detail" id="reproduce-bug">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/reproduce-bug</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
Give it a GitHub issue number and it tries to actually reproduce the bug—reading the issue, analyzing code paths, iterating until it finds the root cause. Then it posts findings back to the issue.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[GitHub issue number]</code></p>
|
||||
<h4>Investigation Process</h4>
|
||||
<ol>
|
||||
<li>Read GitHub issue details</li>
|
||||
<li>Launch parallel investigation agents</li>
|
||||
<li>Analyze code for failure points</li>
|
||||
<li>Iterate until root cause found</li>
|
||||
<li>Post findings to GitHub issue</li>
|
||||
</ol>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/reproduce-bug 142</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="command-detail" id="triage">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/triage</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
Got a pile of code review findings or security audit results? This turns them into actionable todos—one at a time, you decide: create the todo, skip it, or modify and re-present.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[findings list or source type]</code></p>
|
||||
<h4>User Decisions</h4>
|
||||
<ul>
|
||||
<li><strong>"yes"</strong> - Create/update todo file, change status to ready</li>
|
||||
<li><strong>"next"</strong> - Skip and delete from todos</li>
|
||||
<li><strong>"custom"</strong> - Modify and re-present</li>
|
||||
</ul>
|
||||
<div class="callout callout-info">
|
||||
<div class="callout-icon"><i class="fa-solid fa-circle-info"></i></div>
|
||||
<div class="callout-content">
|
||||
<p>This command does NOT write code. It only categorizes and creates todo files.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/triage code-review-findings.txt
|
||||
/triage security-audit-results</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="command-detail" id="resolve-parallel">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/resolve_parallel</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
All those TODO comments scattered through your codebase? This finds them, builds a dependency graph, and spawns parallel agents to resolve them all at once. Clears the backlog in minutes.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[optional: specific TODO pattern or file]</code></p>
|
||||
<h4>Process</h4>
|
||||
<ol>
|
||||
<li>Analyze TODO comments from codebase</li>
|
||||
<li>Create dependency graph (mermaid diagram)</li>
|
||||
<li>Spawn parallel <code>pr-comment-resolver</code> agents</li>
|
||||
<li>Commit and push after completion</li>
|
||||
</ol>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/resolve_parallel
|
||||
/resolve_parallel authentication
|
||||
/resolve_parallel src/auth/</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="command-detail" id="resolve-pr-parallel">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/resolve_pr_parallel</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
Same deal, but for PR review comments. Fetch unresolved threads, spawn parallel resolver agents, commit the fixes, and mark threads as resolved. Your reviewers will wonder how you're so fast.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[optional: PR number or current PR]</code></p>
|
||||
<h4>Process</h4>
|
||||
<ol>
|
||||
<li>Get all unresolved PR comments</li>
|
||||
<li>Create TodoWrite list</li>
|
||||
<li>Launch parallel <code>pr-comment-resolver</code> agents</li>
|
||||
<li>Commit, resolve threads, and push</li>
|
||||
</ol>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/resolve_pr_parallel
|
||||
/resolve_pr_parallel 123</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="command-detail" id="resolve-todo-parallel">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/resolve_todo_parallel</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
Those todo files in your <code>/todos</code> directory? Point this at them and watch parallel agents knock them out—analyzing dependencies, executing in the right order, marking resolved as they finish.
|
||||
</p>
|
||||
<h4>Arguments</h4>
|
||||
<p><code>[optional: specific todo ID or pattern]</code></p>
|
||||
<h4>Process</h4>
|
||||
<ol>
|
||||
<li>Get unresolved TODOs from <code>/todos/*.md</code></li>
|
||||
<li>Analyze dependencies</li>
|
||||
<li>Spawn parallel agents</li>
|
||||
<li>Commit, mark as resolved, push</li>
|
||||
</ol>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/resolve_todo_parallel
|
||||
/resolve_todo_parallel 042
|
||||
/resolve_todo_parallel p1</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="command-detail" id="prime">
|
||||
<div class="command-detail-header">
|
||||
<code class="command-detail-name">/prime</code>
|
||||
</div>
|
||||
<p class="command-detail-description">
|
||||
Your project initialization command. What exactly it does depends on your project setup—think of it as the "get everything ready" button before you start coding.
|
||||
</p>
|
||||
<div class="card-code-block">
|
||||
<pre><code>/prime</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Navigation -->
|
||||
<nav class="docs-nav-footer">
|
||||
<a href="agents.html" class="nav-prev">
|
||||
<span class="nav-label">Previous</span>
|
||||
<span class="nav-title"><i class="fa-solid fa-arrow-left"></i> Agents</span>
|
||||
</a>
|
||||
<a href="skills.html" class="nav-next">
|
||||
<span class="nav-label">Next</span>
|
||||
<span class="nav-title">Skills <i class="fa-solid fa-arrow-right"></i></span>
|
||||
</a>
|
||||
</nav>
|
||||
</article>
|
||||
</main>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
document.querySelector('[data-sidebar-toggle]')?.addEventListener('click', () => {
|
||||
document.querySelector('.docs-sidebar').classList.toggle('open');
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
@@ -1,582 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="theme-dark">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Getting Started - Compounding Engineering</title>
|
||||
<meta content="Complete guide to installing and using the Compounding Engineering plugin for Claude Code." name="description" />
|
||||
<meta content="width=device-width, initial-scale=1" name="viewport" />
|
||||
|
||||
<!-- Styles -->
|
||||
<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">
|
||||
<!-- Sidebar -->
|
||||
<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="#installation" class="active">Installation</a></li>
|
||||
<li><a href="#quick-start">Quick Start</a></li>
|
||||
<li><a href="#configuration">Configuration</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-section">
|
||||
<h3>Core Concepts</h3>
|
||||
<ul>
|
||||
<li><a href="#philosophy">Philosophy</a></li>
|
||||
<li><a href="#agents">Using Agents</a></li>
|
||||
<li><a href="#commands">Using Commands</a></li>
|
||||
<li><a href="#skills">Using Skills</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-section">
|
||||
<h3>Guides</h3>
|
||||
<ul>
|
||||
<li><a href="#code-review">Code Review Workflow</a></li>
|
||||
<li><a href="#creating-agents">Creating Custom Agents</a></li>
|
||||
<li><a href="#creating-skills">Creating Custom Skills</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-section">
|
||||
<h3>Reference</h3>
|
||||
<ul>
|
||||
<li><a href="agents.html">Agent Reference</a></li>
|
||||
<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>
|
||||
</aside>
|
||||
|
||||
<!-- Main Content -->
|
||||
<main class="docs-content">
|
||||
<div class="docs-header">
|
||||
<nav class="breadcrumb">
|
||||
<a href="../index.html">Home</a>
|
||||
<span>/</span>
|
||||
<span>Getting Started</span>
|
||||
</nav>
|
||||
<button class="mobile-menu-toggle" data-sidebar-toggle>
|
||||
<i class="fa-solid fa-bars"></i>
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<article class="docs-article">
|
||||
<h1>Getting Started with Compounding Engineering</h1>
|
||||
<p class="lead">
|
||||
Five minutes from now, you'll run a single command that spins up 10 AI agents—each with a different specialty—to review your pull request in parallel. Security, performance, architecture, accessibility, all happening at once. That's the plugin. Let's get you set up.
|
||||
</p>
|
||||
|
||||
<!-- Installation Section -->
|
||||
<section id="installation">
|
||||
<h2><i class="fa-solid fa-download"></i> Installation</h2>
|
||||
|
||||
<h3>Prerequisites</h3>
|
||||
<ul>
|
||||
<li><a href="https://claude.ai/claude-code" target="_blank">Claude Code</a> installed and configured</li>
|
||||
<li>A GitHub account (for marketplace access)</li>
|
||||
<li>Node.js 18+ (for MCP servers)</li>
|
||||
</ul>
|
||||
|
||||
<h3>Step 1: Add the Marketplace</h3>
|
||||
<p>Think of the marketplace as an app store. You're adding it to Claude Code's list of places to look for plugins:</p>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude /plugin marketplace add https://github.com/EveryInc/compound-engineering-plugin</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>Step 2: Install the Plugin</h3>
|
||||
<p>Now grab the plugin itself:</p>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude /plugin install compound-engineering</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>Step 3: Verify Installation</h3>
|
||||
<p>Check that it worked:</p>
|
||||
<div class="card-code-block">
|
||||
<pre><code>claude /plugin list</code></pre>
|
||||
</div>
|
||||
<p>You'll see <code>compound-engineering</code> in the list. If you do, you're ready.</p>
|
||||
|
||||
<div class="callout callout-info">
|
||||
<div class="callout-icon"><i class="fa-solid fa-circle-info"></i></div>
|
||||
<div class="callout-content">
|
||||
<h4>Known Issue: MCP Servers</h4>
|
||||
<p>
|
||||
The bundled MCP servers (Playwright for browser automation, Context7 for docs) don't always auto-load. If you need them, there's a manual config step below. Otherwise, ignore this—everything else works fine.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Quick Start Section -->
|
||||
<section id="quick-start">
|
||||
<h2><i class="fa-solid fa-rocket"></i> Quick Start</h2>
|
||||
|
||||
<p>Let's see what this thing can actually do. I'll show you three workflows you'll use constantly:</p>
|
||||
|
||||
<h3>Run a Code Review</h3>
|
||||
<p>This is the big one. Type <code>/review</code> and watch it spawn 10+ specialized reviewers:</p>
|
||||
<div class="card-code-block">
|
||||
<pre><code># Review a PR by number
|
||||
/review 123
|
||||
|
||||
# Review the current branch
|
||||
/review
|
||||
|
||||
# Review a specific branch
|
||||
/review feature/my-feature</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>Use a Specialized Agent</h3>
|
||||
<p>Sometimes you just need one expert. Call them directly:</p>
|
||||
<div class="card-code-block">
|
||||
<pre><code># Rails code review with Kieran's conventions
|
||||
claude agent kieran-rails-reviewer "Review the UserController"
|
||||
|
||||
# Security audit
|
||||
claude agent security-sentinel "Audit authentication flow"
|
||||
|
||||
# Research best practices
|
||||
claude agent best-practices-researcher "Find pagination patterns for Rails"</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>Invoke a Skill</h3>
|
||||
<p>Skills are like loading a reference book into Claude's brain. When you need deep knowledge in a specific domain:</p>
|
||||
<div class="card-code-block">
|
||||
<pre><code># Generate images with Gemini
|
||||
skill: gemini-imagegen
|
||||
|
||||
# Write Ruby in DHH's style
|
||||
skill: dhh-ruby-style
|
||||
|
||||
# Create a new Claude Code skill
|
||||
skill: create-agent-skills</code></pre>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Configuration Section -->
|
||||
<section id="configuration">
|
||||
<h2><i class="fa-solid fa-gear"></i> Configuration</h2>
|
||||
|
||||
<h3 id="mcp-configuration">MCP Server Configuration</h3>
|
||||
<p>
|
||||
If the MCP servers didn't load automatically, paste this into <code>.claude/settings.json</code>:
|
||||
</p>
|
||||
<div class="card-code-block">
|
||||
<pre><code>{
|
||||
"mcpServers": {
|
||||
"playwright": {
|
||||
"type": "stdio",
|
||||
"command": "npx",
|
||||
"args": ["-y", "@playwright/mcp@latest"],
|
||||
"env": {}
|
||||
},
|
||||
"context7": {
|
||||
"type": "http",
|
||||
"url": "https://mcp.context7.com/mcp"
|
||||
}
|
||||
}
|
||||
}</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>Environment Variables</h3>
|
||||
<p>Right now, only one skill needs an API key. If you use Gemini's image generation:</p>
|
||||
<table class="docs-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Variable</th>
|
||||
<th>Required For</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>GEMINI_API_KEY</code></td>
|
||||
<td>gemini-imagegen</td>
|
||||
<td>Google Gemini API key for image generation</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
||||
<!-- Philosophy Section -->
|
||||
<section id="philosophy">
|
||||
<h2><i class="fa-solid fa-lightbulb"></i> The Compounding Engineering Philosophy</h2>
|
||||
|
||||
<blockquote class="highlight-quote">
|
||||
Every unit of engineering work should make subsequent units of work easier—not harder.
|
||||
</blockquote>
|
||||
|
||||
<p>Here's how it works in practice—the four-step loop you'll run over and over:</p>
|
||||
|
||||
<div class="philosophy-grid">
|
||||
<div class="philosophy-card">
|
||||
<div class="philosophy-icon"><i class="fa-solid fa-brain"></i></div>
|
||||
<h4>1. Plan</h4>
|
||||
<p>
|
||||
Before you write a single line, figure out what you're building and why. Use research agents to gather examples, patterns, and context. Think of it as Google Search meets expert consultation.
|
||||
</p>
|
||||
</div>
|
||||
<div class="philosophy-card">
|
||||
<div class="philosophy-icon"><i class="fa-solid fa-robot"></i></div>
|
||||
<h4>2. Delegate</h4>
|
||||
<p>
|
||||
Now build it—with help. Each agent specializes in something (Rails, security, design). You stay in the driver's seat, but you've got a team of specialists riding shotgun.
|
||||
</p>
|
||||
</div>
|
||||
<div class="philosophy-card">
|
||||
<div class="philosophy-icon"><i class="fa-solid fa-magnifying-glass"></i></div>
|
||||
<h4>3. Assess</h4>
|
||||
<p>
|
||||
Before you ship, run the gauntlet. Security agent checks for vulnerabilities. Performance agent flags N+1 queries. Architecture agent questions your design choices. All at once, all in parallel.
|
||||
</p>
|
||||
</div>
|
||||
<div class="philosophy-card">
|
||||
<div class="philosophy-icon"><i class="fa-solid fa-book"></i></div>
|
||||
<h4>4. Codify</h4>
|
||||
<p>
|
||||
You just solved a problem. Write it down. Next time you (or your teammate) face this, you'll have a runbook. That's the "compounding" part—each solution makes the next one faster.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Using Agents Section -->
|
||||
<section id="agents">
|
||||
<h2><i class="fa-solid fa-users-gear"></i> Using Agents</h2>
|
||||
|
||||
<p>
|
||||
Think of agents as coworkers with different job titles. You wouldn't ask your security engineer to design your UI, right? Same concept here—each agent has a specialty, and you call the one you need.
|
||||
</p>
|
||||
|
||||
<h3>Invoking Agents</h3>
|
||||
<div class="card-code-block">
|
||||
<pre><code># Basic syntax
|
||||
claude agent [agent-name] "[optional message]"
|
||||
|
||||
# Examples
|
||||
claude agent kieran-rails-reviewer
|
||||
claude agent security-sentinel "Audit the payment flow"
|
||||
claude agent git-history-analyzer "Show changes to user model"</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>Agent Categories</h3>
|
||||
<table class="docs-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Category</th>
|
||||
<th>Count</th>
|
||||
<th>Purpose</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Review</td>
|
||||
<td>10</td>
|
||||
<td>Code review, security audits, performance analysis</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Research</td>
|
||||
<td>four</td>
|
||||
<td>Best practices, documentation, git history</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Design</td>
|
||||
<td>three</td>
|
||||
<td>UI iteration, Figma sync, design review</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Workflow</td>
|
||||
<td>five</td>
|
||||
<td>Bug reproduction, PR resolution, linting</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Docs</td>
|
||||
<td>one</td>
|
||||
<td>README generation</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<p>
|
||||
<a href="agents.html" class="button secondary">
|
||||
<i class="fa-solid fa-arrow-right"></i> View All Agents
|
||||
</a>
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<!-- Using Commands Section -->
|
||||
<section id="commands">
|
||||
<h2><i class="fa-solid fa-terminal"></i> Using Commands</h2>
|
||||
|
||||
<p>
|
||||
Commands are macros that run entire workflows for you. One command can spin up a dozen agents, coordinate their work, collect results, and hand you a summary. It's automation all the way down.
|
||||
</p>
|
||||
|
||||
<h3>Running Commands</h3>
|
||||
<div class="card-code-block">
|
||||
<pre><code># Workflow commands
|
||||
/plan
|
||||
/review 123
|
||||
/work
|
||||
/compound
|
||||
|
||||
# Utility commands
|
||||
/changelog
|
||||
/triage
|
||||
/reproduce-bug</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>The Review Workflow</h3>
|
||||
<p>Let me show you what happens when you run <code>/review</code>. Here's the sequence:</p>
|
||||
<ol>
|
||||
<li><strong>Detection</strong> - Figures out what you want reviewed (PR number, branch name, or current changes)</li>
|
||||
<li><strong>Isolation</strong> - Spins up a git worktree so the review doesn't mess with your working directory</li>
|
||||
<li><strong>Parallel execution</strong> - Launches 10+ agents simultaneously (security, performance, architecture, accessibility...)</li>
|
||||
<li><strong>Synthesis</strong> - Sorts findings by severity (P1 = blocks merge, P2 = should fix, P3 = nice-to-have)</li>
|
||||
<li><strong>Persistence</strong> - Creates todo files so you don't lose track of issues</li>
|
||||
<li><strong>Summary</strong> - Hands you a readable report with action items</li>
|
||||
</ol>
|
||||
|
||||
<p>
|
||||
<a href="commands.html" class="button secondary">
|
||||
<i class="fa-solid fa-arrow-right"></i> View All Commands
|
||||
</a>
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<!-- Using Skills Section -->
|
||||
<section id="skills">
|
||||
<h2><i class="fa-solid fa-wand-magic-sparkles"></i> Using Skills</h2>
|
||||
|
||||
<p>
|
||||
Here's the difference: agents are <em>who</em> does the work, skills are <em>what they know</em>. When you invoke a skill, you're loading a reference library into Claude's context—patterns, templates, examples, workflows. It's like handing Claude a technical manual.
|
||||
</p>
|
||||
|
||||
<h3>Invoking Skills</h3>
|
||||
<div class="card-code-block">
|
||||
<pre><code># In your prompt, reference the skill
|
||||
skill: gemini-imagegen
|
||||
|
||||
# Or ask Claude to use it
|
||||
"Use the dhh-ruby-style skill to refactor this code"</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>Skill Structure</h3>
|
||||
<p>Peek inside a skill directory and you'll usually find:</p>
|
||||
<ul>
|
||||
<li><strong>SKILL.md</strong> - The main instructions (what Claude reads first)</li>
|
||||
<li><strong>references/</strong> - Deep dives on concepts and patterns</li>
|
||||
<li><strong>templates/</strong> - Copy-paste code snippets</li>
|
||||
<li><strong>workflows/</strong> - Step-by-step "how to" guides</li>
|
||||
<li><strong>scripts/</strong> - Actual executable code (when words aren't enough)</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
<a href="skills.html" class="button secondary">
|
||||
<i class="fa-solid fa-arrow-right"></i> View All Skills
|
||||
</a>
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<!-- Code Review Workflow Guide -->
|
||||
<section id="code-review">
|
||||
<h2><i class="fa-solid fa-code-pull-request"></i> Code Review Workflow Guide</h2>
|
||||
|
||||
<p>
|
||||
You'll spend most of your time here. This workflow is why the plugin exists—to turn code review from a bottleneck into a superpower.
|
||||
</p>
|
||||
|
||||
<h3>Basic Review</h3>
|
||||
<div class="card-code-block">
|
||||
<pre><code># Review a PR
|
||||
/review 123
|
||||
|
||||
# Review current branch
|
||||
/review</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>Understanding Findings</h3>
|
||||
<p>Every finding gets a priority label. Here's what they mean:</p>
|
||||
<ul>
|
||||
<li><span class="badge badge-critical">P1 Critical</span> - Don't merge until this is fixed. Think: SQL injection, data loss, crashes in production.</li>
|
||||
<li><span class="badge badge-important">P2 Important</span> - Fix before shipping. Performance regressions, N+1 queries, shaky architecture.</li>
|
||||
<li><span class="badge badge-nice">P3 Nice-to-Have</span> - Would be better, but ship without it if you need to. Documentation, minor cleanup, style issues.</li>
|
||||
</ul>
|
||||
|
||||
<h3>Working with Todo Files</h3>
|
||||
<p>After a review, you'll have a <code>todos/</code> directory full of markdown files. Each one is a single issue to fix:</p>
|
||||
<div class="card-code-block">
|
||||
<pre><code># List all pending todos
|
||||
ls todos/*-pending-*.md
|
||||
|
||||
# Triage findings
|
||||
/triage
|
||||
|
||||
# Resolve todos in parallel
|
||||
/resolve_todo_parallel</code></pre>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Creating Custom Agents -->
|
||||
<section id="creating-agents">
|
||||
<h2><i class="fa-solid fa-plus"></i> Creating Custom Agents</h2>
|
||||
|
||||
<p>
|
||||
The built-in agents cover a lot of ground, but every team has unique needs. Maybe you want a "rails-api-reviewer" that enforces your company's API standards. That's 10 minutes of work.
|
||||
</p>
|
||||
|
||||
<h3>Agent File Structure</h3>
|
||||
<div class="card-code-block">
|
||||
<pre><code>---
|
||||
name: my-custom-agent
|
||||
description: Brief description of what this agent does
|
||||
---
|
||||
|
||||
# Agent Instructions
|
||||
|
||||
You are [role description].
|
||||
|
||||
## Your Responsibilities
|
||||
1. First responsibility
|
||||
2. Second responsibility
|
||||
|
||||
## Guidelines
|
||||
- Guideline one
|
||||
- Guideline two</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>Agent Location</h3>
|
||||
<p>Drop your agent file in one of these directories:</p>
|
||||
<ul>
|
||||
<li><code>.claude/agents/</code> - Just for this project (committed to git)</li>
|
||||
<li><code>~/.claude/agents/</code> - Available in all your projects (stays on your machine)</li>
|
||||
</ul>
|
||||
|
||||
<div class="callout callout-tip">
|
||||
<div class="callout-icon"><i class="fa-solid fa-lightbulb"></i></div>
|
||||
<div class="callout-content">
|
||||
<h4>The Easy Way</h4>
|
||||
<p>
|
||||
Don't write the YAML by hand. Just run <code>/create-agent-skill</code> and answer a few questions. The command generates the file, validates the format, and puts it in the right place.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Creating Custom Skills -->
|
||||
<section id="creating-skills">
|
||||
<h2><i class="fa-solid fa-plus"></i> Creating Custom Skills</h2>
|
||||
|
||||
<p>
|
||||
Skills are heavier than agents—they're knowledge bases, not just prompts. You're building a mini library that Claude can reference. Worth the effort for things you do repeatedly.
|
||||
</p>
|
||||
|
||||
<h3>Skill Directory Structure</h3>
|
||||
<div class="card-code-block">
|
||||
<pre><code>my-skill/
|
||||
SKILL.md # Main skill file (required)
|
||||
references/ # Supporting documentation
|
||||
concept-one.md
|
||||
concept-two.md
|
||||
templates/ # Code templates
|
||||
basic-template.md
|
||||
workflows/ # Step-by-step procedures
|
||||
workflow-one.md
|
||||
scripts/ # Executable scripts
|
||||
helper.py</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>SKILL.md Format</h3>
|
||||
<div class="card-code-block">
|
||||
<pre><code>---
|
||||
name: my-skill
|
||||
description: Brief description shown when skill is invoked
|
||||
---
|
||||
|
||||
# Skill Title
|
||||
|
||||
Detailed instructions for using this skill.
|
||||
|
||||
## Quick Start
|
||||
...
|
||||
|
||||
## Reference Materials
|
||||
The skill includes references in the `references/` directory.
|
||||
|
||||
## Templates
|
||||
Use templates from the `templates/` directory.</code></pre>
|
||||
</div>
|
||||
|
||||
<div class="callout callout-tip">
|
||||
<div class="callout-icon"><i class="fa-solid fa-lightbulb"></i></div>
|
||||
<div class="callout-content">
|
||||
<h4>Get Help Building Skills</h4>
|
||||
<p>
|
||||
Type <code>skill: create-agent-skills</code> and Claude loads expert guidance on skill architecture, best practices, file organization, and validation. It's like having a senior engineer walk you through it.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Navigation -->
|
||||
<nav class="docs-nav-footer">
|
||||
<a href="../index.html" class="nav-prev">
|
||||
<span class="nav-label">Previous</span>
|
||||
<span class="nav-title"><i class="fa-solid fa-arrow-left"></i> Home</span>
|
||||
</a>
|
||||
<a href="agents.html" class="nav-next">
|
||||
<span class="nav-label">Next</span>
|
||||
<span class="nav-title">Agent Reference <i class="fa-solid fa-arrow-right"></i></span>
|
||||
</a>
|
||||
</nav>
|
||||
</article>
|
||||
</main>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
// Sidebar toggle for mobile
|
||||
document.querySelector('[data-sidebar-toggle]')?.addEventListener('click', () => {
|
||||
document.querySelector('.docs-sidebar').classList.toggle('open');
|
||||
});
|
||||
|
||||
// Active link highlighting
|
||||
const sections = document.querySelectorAll('section[id]');
|
||||
const navLinks = document.querySelectorAll('.sidebar-nav a');
|
||||
|
||||
window.addEventListener('scroll', () => {
|
||||
let current = '';
|
||||
sections.forEach(section => {
|
||||
const sectionTop = section.offsetTop;
|
||||
if (pageYOffset >= sectionTop - 100) {
|
||||
current = section.getAttribute('id');
|
||||
}
|
||||
});
|
||||
|
||||
navLinks.forEach(link => {
|
||||
link.classList.remove('active');
|
||||
if (link.getAttribute('href') === `#${current}`) {
|
||||
link.classList.add('active');
|
||||
}
|
||||
});
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
@@ -1,409 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="theme-dark">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>MCP Servers Reference - Compounding Engineering</title>
|
||||
<meta content="Complete reference for the two MCP servers in 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 (23)</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 (two)</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>
|
||||
<li><a href="#playwright">Playwright</a></li>
|
||||
<li><a href="#context7">Context7</a></li>
|
||||
<li><a href="#manual-config">Manual Configuration</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>MCP Servers</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-server color-accent"></i> MCP Servers Reference</h1>
|
||||
<p class="lead">
|
||||
Think of MCP servers as power tools that plug into Claude Code. Want Claude to actually <em>open a browser</em> and click around your app? That's Playwright. Need the latest Rails docs without leaving your terminal? That's Context7. The plugin bundles both servers—they just work when you install.
|
||||
</p>
|
||||
|
||||
<div class="callout callout-warning">
|
||||
<div class="callout-icon"><i class="fa-solid fa-triangle-exclamation"></i></div>
|
||||
<div class="callout-content">
|
||||
<h4>Known Issue: Auto-Loading</h4>
|
||||
<p>
|
||||
Sometimes MCP servers don't wake up automatically. If Claude can't take screenshots or look up docs, you'll need to add them manually. See <a href="#manual-config">Manual Configuration</a> for the fix.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Playwright -->
|
||||
<section id="playwright">
|
||||
<h2><i class="fa-brands fa-chrome"></i> Playwright</h2>
|
||||
<p>
|
||||
You know how you can tell a junior developer "open Chrome and click the login button"? Now you can tell Claude the same thing. Playwright gives Claude hands to control a real browser—clicking buttons, filling forms, taking screenshots, running JavaScript. It's like pair programming with someone who has a browser open next to you.
|
||||
</p>
|
||||
|
||||
<h3>Tools Provided</h3>
|
||||
<table class="docs-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Tool</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>browser_navigate</code></td>
|
||||
<td>Go to any URL—your localhost dev server, production, staging, that competitor's site you're studying</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>browser_take_screenshot</code></td>
|
||||
<td>Capture what you're seeing right now. Perfect for "does this look right?" design reviews</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>browser_click</code></td>
|
||||
<td>Click buttons, links, whatever. Claude finds it by text or CSS selector, just like you would</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>browser_fill_form</code></td>
|
||||
<td>Type into forms faster than you can. Great for testing signup flows without manual clicking</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>browser_snapshot</code></td>
|
||||
<td>Get the page's accessibility tree—how screen readers see it. Useful for understanding structure without HTML noise</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>browser_evaluate</code></td>
|
||||
<td>Run any JavaScript in the page. Check localStorage, trigger functions, read variables—full console access</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<h3>When You'll Use This</h3>
|
||||
<ul>
|
||||
<li><strong>Design reviews without leaving the terminal</strong> - "Take a screenshot of the new navbar on mobile" gets you a PNG in seconds</li>
|
||||
<li><strong>Testing signup flows while you code</strong> - "Fill in the registration form with test@example.com and click submit" runs the test for you</li>
|
||||
<li><strong>Debugging production issues</strong> - "Navigate to the error page and show me what's in localStorage" gives you the state without opening DevTools</li>
|
||||
<li><strong>Competitive research</strong> - "Go to competitor.com and screenshot their pricing page" builds your swipe file automatically</li>
|
||||
</ul>
|
||||
|
||||
<h3>Example Usage</h3>
|
||||
<div class="card-code-block">
|
||||
<pre><code># Just talk to Claude naturally—it knows when to use Playwright
|
||||
|
||||
# Design review
|
||||
"Take a screenshot of the login page"
|
||||
|
||||
# Testing a form
|
||||
"Navigate to /signup and fill in the email field with test@example.com"
|
||||
|
||||
# Debug JavaScript state
|
||||
"Go to localhost:3000 and run console.log(window.currentUser)"
|
||||
|
||||
# The browser runs in the background. You'll get results without switching windows.</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>Configuration</h3>
|
||||
<div class="card-code-block">
|
||||
<pre><code>{
|
||||
"playwright": {
|
||||
"type": "stdio",
|
||||
"command": "npx",
|
||||
"args": ["-y", "@playwright/mcp@latest"],
|
||||
"env": {}
|
||||
}
|
||||
}</code></pre>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Context7 -->
|
||||
<section id="context7">
|
||||
<h2><i class="fa-solid fa-book-open"></i> Context7</h2>
|
||||
<p>
|
||||
Ever ask Claude about a framework and get an answer from 2023? Context7 fixes that. It's a documentation service that keeps Claude current with 100+ frameworks—Rails, React, Next.js, Django, whatever you're using. Think of it as having the official docs piped directly into Claude's brain.
|
||||
</p>
|
||||
|
||||
<h3>Tools Provided</h3>
|
||||
<table class="docs-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Tool</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>resolve-library-id</code></td>
|
||||
<td>Maps "Rails" to the actual library identifier Context7 uses. You don't call this—Claude does it automatically</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>get-library-docs</code></td>
|
||||
<td>Fetches the actual documentation pages. Ask "How does useEffect work?" and this grabs the latest React docs</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<h3>What's Covered</h3>
|
||||
<p>Over 100 frameworks and libraries. Here's a taste of what you can look up:</p>
|
||||
<div class="framework-grid">
|
||||
<div class="framework-category">
|
||||
<h4>Backend</h4>
|
||||
<ul>
|
||||
<li>Ruby on Rails</li>
|
||||
<li>Django</li>
|
||||
<li>Laravel</li>
|
||||
<li>Express</li>
|
||||
<li>FastAPI</li>
|
||||
<li>Spring Boot</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="framework-category">
|
||||
<h4>Frontend</h4>
|
||||
<ul>
|
||||
<li>React</li>
|
||||
<li>Vue.js</li>
|
||||
<li>Angular</li>
|
||||
<li>Svelte</li>
|
||||
<li>Next.js</li>
|
||||
<li>Nuxt</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="framework-category">
|
||||
<h4>Mobile</h4>
|
||||
<ul>
|
||||
<li>React Native</li>
|
||||
<li>Flutter</li>
|
||||
<li>SwiftUI</li>
|
||||
<li>Kotlin</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="framework-category">
|
||||
<h4>Tools & Libraries</h4>
|
||||
<ul>
|
||||
<li>Tailwind CSS</li>
|
||||
<li>PostgreSQL</li>
|
||||
<li>Redis</li>
|
||||
<li>GraphQL</li>
|
||||
<li>Prisma</li>
|
||||
<li>And many more...</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3>Example Usage</h3>
|
||||
<div class="card-code-block">
|
||||
<pre><code># Just ask about the framework—Claude fetches current docs automatically
|
||||
|
||||
"Look up the Rails ActionCable documentation"
|
||||
|
||||
"How does the useEffect hook work in React?"
|
||||
|
||||
"What are the best practices for PostgreSQL indexes?"
|
||||
|
||||
# You get answers based on the latest docs, not Claude's training cutoff</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>Configuration</h3>
|
||||
<div class="card-code-block">
|
||||
<pre><code>{
|
||||
"context7": {
|
||||
"type": "http",
|
||||
"url": "https://mcp.context7.com/mcp"
|
||||
}
|
||||
}</code></pre>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Manual Configuration -->
|
||||
<section id="manual-config">
|
||||
<h2><i class="fa-solid fa-gear"></i> Manual Configuration</h2>
|
||||
<p>
|
||||
If the servers don't load automatically (you'll know because Claude can't take screenshots or fetch docs), you need to wire them up yourself. It's a two-minute copy-paste job.
|
||||
</p>
|
||||
|
||||
<h3>Project-Level Configuration</h3>
|
||||
<p>To enable for just this project, add this to <code>.claude/settings.json</code> in your project root:</p>
|
||||
<div class="card-code-block">
|
||||
<pre><code>{
|
||||
"mcpServers": {
|
||||
"playwright": {
|
||||
"type": "stdio",
|
||||
"command": "npx",
|
||||
"args": ["-y", "@playwright/mcp@latest"],
|
||||
"env": {}
|
||||
},
|
||||
"context7": {
|
||||
"type": "http",
|
||||
"url": "https://mcp.context7.com/mcp"
|
||||
}
|
||||
}
|
||||
}</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>Global Configuration</h3>
|
||||
<p>Or enable everywhere—every project on your machine gets these servers. Add to <code>~/.claude/settings.json</code>:</p>
|
||||
<div class="card-code-block">
|
||||
<pre><code>{
|
||||
"mcpServers": {
|
||||
"playwright": {
|
||||
"type": "stdio",
|
||||
"command": "npx",
|
||||
"args": ["-y", "@playwright/mcp@latest"],
|
||||
"env": {}
|
||||
},
|
||||
"context7": {
|
||||
"type": "http",
|
||||
"url": "https://mcp.context7.com/mcp"
|
||||
}
|
||||
}
|
||||
}</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>Requirements</h3>
|
||||
<table class="docs-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Server</th>
|
||||
<th>Requirement</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Playwright</td>
|
||||
<td>Node.js 18+ and npx</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Context7</td>
|
||||
<td>Internet connection (HTTP endpoint)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<h3>Verifying MCP Servers</h3>
|
||||
<p>After you add the config, restart Claude Code. Then test that everything works:</p>
|
||||
<div class="card-code-block">
|
||||
<pre><code># Ask Claude what it has
|
||||
"What MCP tools do you have access to?"
|
||||
|
||||
# Test Playwright (should work now)
|
||||
"Take a screenshot of the current directory listing"
|
||||
|
||||
# Test Context7 (should fetch real docs)
|
||||
"Look up Rails Active Record documentation"
|
||||
|
||||
# If either fails, double-check your JSON syntax and file paths</code></pre>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Navigation -->
|
||||
<nav class="docs-nav-footer">
|
||||
<a href="skills.html" class="nav-prev">
|
||||
<span class="nav-label">Previous</span>
|
||||
<span class="nav-title"><i class="fa-solid fa-arrow-left"></i> Skills</span>
|
||||
</a>
|
||||
<a href="getting-started.html" class="nav-next">
|
||||
<span class="nav-label">Back to</span>
|
||||
<span class="nav-title">Getting Started <i class="fa-solid fa-arrow-right"></i></span>
|
||||
</a>
|
||||
</nav>
|
||||
</article>
|
||||
</main>
|
||||
</div>
|
||||
|
||||
<style>
|
||||
.framework-grid {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(2, 1fr);
|
||||
gap: var(--space-l);
|
||||
margin: var(--space-l) 0;
|
||||
}
|
||||
|
||||
@media (min-width: 768px) {
|
||||
.framework-grid {
|
||||
grid-template-columns: repeat(4, 1fr);
|
||||
}
|
||||
}
|
||||
|
||||
.framework-category {
|
||||
background-color: var(--color-surface);
|
||||
padding: var(--space-l);
|
||||
border-radius: var(--radius-m);
|
||||
border: 1px solid var(--color-border);
|
||||
}
|
||||
|
||||
.framework-category h4 {
|
||||
margin: 0 0 var(--space-s) 0;
|
||||
color: var(--color-accent);
|
||||
font-size: var(--font-size-s);
|
||||
}
|
||||
|
||||
.framework-category ul {
|
||||
margin: 0;
|
||||
padding-left: var(--space-l);
|
||||
}
|
||||
|
||||
.framework-category li {
|
||||
margin: var(--space-xs) 0;
|
||||
font-size: var(--font-size-s);
|
||||
color: var(--color-text-secondary);
|
||||
}
|
||||
</style>
|
||||
|
||||
<script>
|
||||
document.querySelector('[data-sidebar-toggle]')?.addEventListener('click', () => {
|
||||
document.querySelector('.docs-sidebar').classList.toggle('open');
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
@@ -1,611 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="theme-dark">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Skill Reference - Compounding Engineering</title>
|
||||
<meta content="Complete reference for all 12 intelligent skills in 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 (27)</a></li>
|
||||
<li><a href="commands.html">Commands (19)</a></li>
|
||||
<li><a href="skills.html" class="active">Skills (12)</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>
|
||||
<li><a href="#development-tools">Development (8)</a></li>
|
||||
<li><a href="#content-workflow">Content & Workflow (3)</a></li>
|
||||
<li><a href="#image-generation">Image Generation (1)</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>Skills</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-wand-magic-sparkles color-accent"></i> Skill Reference</h1>
|
||||
<p class="lead">
|
||||
Think of skills as reference manuals that Claude Code can read mid-conversation. When you're writing Rails code and want DHH's style, or building a gem like Andrew Kane would, you don't need to paste documentation—just invoke the skill. Claude reads it, absorbs the patterns, and writes code that way.
|
||||
</p>
|
||||
|
||||
<div class="usage-box">
|
||||
<h3>How to Use Skills</h3>
|
||||
<div class="card-code-block">
|
||||
<pre><code># In your prompt, reference the skill
|
||||
skill: [skill-name]
|
||||
|
||||
# Examples
|
||||
skill: gemini-imagegen
|
||||
skill: dhh-rails-style
|
||||
skill: create-agent-skills</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="callout callout-info">
|
||||
<div class="callout-icon"><i class="fa-solid fa-circle-info"></i></div>
|
||||
<div class="callout-content">
|
||||
<h4>Skills vs Agents</h4>
|
||||
<p>
|
||||
<strong>Agents</strong> are personas—they <em>do</em> things. <strong>Skills</strong> are knowledge—they teach Claude <em>how</em> to do things. Use <code>claude agent [name]</code> when you want someone to review your code. Use <code>skill: [name]</code> when you want to write code in a particular style yourself.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Development Tools -->
|
||||
<section id="development-tools">
|
||||
<h2><i class="fa-solid fa-code"></i> Development Tools (8)</h2>
|
||||
<p>These skills teach Claude specific coding styles and architectural patterns. Use them when you want code that follows a particular philosophy—not just any working code, but code that looks like it was written by a specific person or framework.</p>
|
||||
|
||||
<div class="skill-detail" id="create-agent-skills">
|
||||
<div class="skill-detail-header">
|
||||
<h3>create-agent-skills</h3>
|
||||
<span class="skill-badge">Meta</span>
|
||||
</div>
|
||||
<p class="skill-detail-description">
|
||||
You're writing a skill right now, but you're not sure if you're structuring the SKILL.md file correctly. Should the examples go before the theory? How do you organize workflows vs. references? This skill is the answer—it's the master template for building skills themselves.
|
||||
</p>
|
||||
<h4>Capabilities</h4>
|
||||
<ul>
|
||||
<li>Skill architecture and best practices</li>
|
||||
<li>Router pattern for complex multi-step skills</li>
|
||||
<li>Progressive disclosure design principles</li>
|
||||
<li>SKILL.md structure guidance</li>
|
||||
<li>Asset management (workflows, references, templates, scripts)</li>
|
||||
<li>XML structure patterns</li>
|
||||
</ul>
|
||||
<h4>Workflows Included</h4>
|
||||
<ul>
|
||||
<li><code>create-new-skill</code> - Start from scratch</li>
|
||||
<li><code>add-reference</code> - Add reference documentation</li>
|
||||
<li><code>add-template</code> - Add code templates</li>
|
||||
<li><code>add-workflow</code> - Add step-by-step procedures</li>
|
||||
<li><code>add-script</code> - Add executable scripts</li>
|
||||
<li><code>audit-skill</code> - Validate skill structure</li>
|
||||
<li><code>verify-skill</code> - Test skill functionality</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>skill: create-agent-skills</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="skill-detail" id="skill-creator">
|
||||
<div class="skill-detail-header">
|
||||
<h3>skill-creator</h3>
|
||||
<span class="skill-badge">Meta</span>
|
||||
</div>
|
||||
<p class="skill-detail-description">
|
||||
The simpler, step-by-step version of <code>create-agent-skills</code>. When you just want a checklist to follow from blank file to packaged skill, use this. It's less about theory, more about "do step 1, then step 2."
|
||||
</p>
|
||||
<h4>6-Step Process</h4>
|
||||
<ol>
|
||||
<li>Understand skill usage patterns with examples</li>
|
||||
<li>Plan reusable skill contents</li>
|
||||
<li>Initialize skill using template</li>
|
||||
<li>Edit skill with clear instructions</li>
|
||||
<li>Package skill into distributable zip</li>
|
||||
<li>Iterate based on testing feedback</li>
|
||||
</ol>
|
||||
<div class="card-code-block">
|
||||
<pre><code>skill: skill-creator</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="skill-detail" id="dhh-rails-style">
|
||||
<div class="skill-detail-header">
|
||||
<h3>dhh-rails-style</h3>
|
||||
<span class="skill-badge">Rails</span>
|
||||
</div>
|
||||
<p class="skill-detail-description">
|
||||
Comprehensive 37signals Rails conventions based on Marc Köhlbrugge's analysis of 265 PRs from the Fizzy codebase. Covers everything from REST mapping to state-as-records, Turbo/Stimulus patterns, CSS with OKLCH colors, Minitest with fixtures, and Solid Queue/Cache/Cable patterns.
|
||||
</p>
|
||||
<h4>Key Patterns</h4>
|
||||
<ul>
|
||||
<li><strong>REST Purity</strong> - Verbs become nouns (close → closure)</li>
|
||||
<li><strong>State as Records</strong> - Boolean columns → separate records</li>
|
||||
<li><strong>Fat Models</strong> - Business logic, authorization, broadcasting</li>
|
||||
<li><strong>Thin Controllers</strong> - 1-5 line actions with concerns</li>
|
||||
<li><strong>Current Attributes</strong> - Request context everywhere</li>
|
||||
<li><strong>Hotwire/Turbo</strong> - Model-level broadcasting, morphing</li>
|
||||
</ul>
|
||||
<h4>Reference Files (6)</h4>
|
||||
<ul>
|
||||
<li><code>controllers.md</code> - REST mapping, concerns, Turbo responses</li>
|
||||
<li><code>models.md</code> - Concerns, state records, callbacks, POROs</li>
|
||||
<li><code>frontend.md</code> - Turbo, Stimulus, CSS layers, OKLCH</li>
|
||||
<li><code>architecture.md</code> - Routing, auth, jobs, caching</li>
|
||||
<li><code>testing.md</code> - Minitest, fixtures, integration tests</li>
|
||||
<li><code>gems.md</code> - What to use vs avoid, decision framework</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>skill: dhh-rails-style</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="skill-detail" id="andrew-kane-gem-writer">
|
||||
<div class="skill-detail-header">
|
||||
<h3>andrew-kane-gem-writer</h3>
|
||||
<span class="skill-badge">Ruby</span>
|
||||
</div>
|
||||
<p class="skill-detail-description">
|
||||
Andrew Kane has written 100+ Ruby gems with 374 million downloads. Every gem follows the same patterns: minimal dependencies, class macro DSLs, Rails integration without Rails coupling. When you're building a gem and want it to feel production-ready from day one, this is how you do it.
|
||||
</p>
|
||||
<h4>Philosophy</h4>
|
||||
<ul>
|
||||
<li>Simplicity over cleverness</li>
|
||||
<li>Zero or minimal dependencies</li>
|
||||
<li>Explicit code over metaprogramming</li>
|
||||
<li>Rails integration without Rails coupling</li>
|
||||
</ul>
|
||||
<h4>Key Patterns</h4>
|
||||
<ul>
|
||||
<li>Class macro DSL for configuration</li>
|
||||
<li><code>ActiveSupport.on_load</code> for Rails integration</li>
|
||||
<li><code>class << self</code> with <code>attr_accessor</code></li>
|
||||
<li>Railtie pattern for hooks</li>
|
||||
<li>Minitest (no RSpec)</li>
|
||||
</ul>
|
||||
<h4>Reference Files</h4>
|
||||
<ul>
|
||||
<li><code>references/module-organization.md</code></li>
|
||||
<li><code>references/rails-integration.md</code></li>
|
||||
<li><code>references/database-adapters.md</code></li>
|
||||
<li><code>references/testing-patterns.md</code></li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>skill: andrew-kane-gem-writer</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="skill-detail" id="dspy-ruby">
|
||||
<div class="skill-detail-header">
|
||||
<h3>dspy-ruby</h3>
|
||||
<span class="skill-badge">AI</span>
|
||||
</div>
|
||||
<p class="skill-detail-description">
|
||||
You're adding AI features to your Rails app, but you don't want brittle prompt strings scattered everywhere. DSPy.rb gives you type-safe signatures, composable predictors, and tool-using agents. This skill shows you how to use it—from basic inference to ReAct agents that iterate until they get the answer right.
|
||||
</p>
|
||||
<h4>Predictor Types</h4>
|
||||
<ul>
|
||||
<li><strong>Predict</strong> - Basic inference</li>
|
||||
<li><strong>ChainOfThought</strong> - Reasoning with explanations</li>
|
||||
<li><strong>ReAct</strong> - Tool-using agents with iteration</li>
|
||||
<li><strong>CodeAct</strong> - Dynamic code generation</li>
|
||||
</ul>
|
||||
<h4>Supported Providers</h4>
|
||||
<ul>
|
||||
<li>OpenAI (GPT-4, GPT-4o-mini)</li>
|
||||
<li>Anthropic Claude</li>
|
||||
<li>Google Gemini</li>
|
||||
<li>Ollama (free, local)</li>
|
||||
<li>OpenRouter</li>
|
||||
</ul>
|
||||
<h4>Requirements</h4>
|
||||
<table class="docs-table">
|
||||
<tr>
|
||||
<td><code>OPENAI_API_KEY</code></td>
|
||||
<td>For OpenAI provider</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ANTHROPIC_API_KEY</code></td>
|
||||
<td>For Anthropic provider</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>GOOGLE_API_KEY</code></td>
|
||||
<td>For Gemini provider</td>
|
||||
</tr>
|
||||
</table>
|
||||
<div class="card-code-block">
|
||||
<pre><code>skill: dspy-ruby</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="skill-detail" id="frontend-design">
|
||||
<div class="skill-detail-header">
|
||||
<h3>frontend-design</h3>
|
||||
<span class="skill-badge">Design</span>
|
||||
</div>
|
||||
<p class="skill-detail-description">
|
||||
You've seen what AI usually generates: Inter font, purple gradients, rounded corners on everything. This skill teaches Claude to design interfaces that don't look like every other AI-generated site. It's about purposeful typography, unexpected color palettes, and interfaces with personality.
|
||||
</p>
|
||||
<h4>Design Thinking</h4>
|
||||
<ul>
|
||||
<li><strong>Purpose</strong> - What is the interface for?</li>
|
||||
<li><strong>Tone</strong> - What feeling should it evoke?</li>
|
||||
<li><strong>Constraints</strong> - Technical and brand limitations</li>
|
||||
<li><strong>Differentiation</strong> - How to stand out</li>
|
||||
</ul>
|
||||
<h4>Focus Areas</h4>
|
||||
<ul>
|
||||
<li>Typography with distinctive font choices</li>
|
||||
<li>Color & theme coherence with CSS variables</li>
|
||||
<li>Motion and animation patterns</li>
|
||||
<li>Spatial composition with asymmetry</li>
|
||||
<li>Backgrounds (gradients, textures, patterns)</li>
|
||||
</ul>
|
||||
<div class="callout callout-tip">
|
||||
<div class="callout-icon"><i class="fa-solid fa-lightbulb"></i></div>
|
||||
<div class="callout-content">
|
||||
<p>Avoids generic AI aesthetics like Inter fonts, purple gradients, and rounded corners everywhere.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card-code-block">
|
||||
<pre><code>skill: frontend-design</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="skill-detail" id="compound-docs">
|
||||
<div class="skill-detail-header">
|
||||
<h3>compound-docs</h3>
|
||||
<span class="skill-badge">Docs</span>
|
||||
</div>
|
||||
<p class="skill-detail-description">
|
||||
You just fixed a weird build error after an hour of debugging. Tomorrow you'll forget how you fixed it. This skill automatically detects when you solve something (phrases like "that worked" or "it's fixed") and documents it with YAML frontmatter so you can find it again. Each documented solution compounds your team's knowledge.
|
||||
</p>
|
||||
<h4>Auto-Triggers</h4>
|
||||
<p>Phrases: "that worked", "it's fixed", "working now", "problem solved"</p>
|
||||
<h4>7-Step Process</h4>
|
||||
<ol>
|
||||
<li>Detect confirmation phrase</li>
|
||||
<li>Gather context (module, symptom, investigation, root cause)</li>
|
||||
<li>Check existing docs for similar issues</li>
|
||||
<li>Generate filename</li>
|
||||
<li>Validate YAML frontmatter</li>
|
||||
<li>Create documentation in category directory</li>
|
||||
<li>Cross-reference related issues</li>
|
||||
</ol>
|
||||
<h4>Categories</h4>
|
||||
<ul>
|
||||
<li><code>build-errors/</code></li>
|
||||
<li><code>test-failures/</code></li>
|
||||
<li><code>runtime-errors/</code></li>
|
||||
<li><code>performance-issues/</code></li>
|
||||
<li><code>database-issues/</code></li>
|
||||
<li><code>security-issues/</code></li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>skill: compound-docs</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="skill-detail" id="agent-native-architecture">
|
||||
<div class="skill-detail-header">
|
||||
<h3>agent-native-architecture</h3>
|
||||
<span class="skill-badge">AI</span>
|
||||
</div>
|
||||
<p class="skill-detail-description">
|
||||
Build AI agents using prompt-native architecture where features are defined in prompts, not code. When creating autonomous agents, designing MCP servers, or implementing self-modifying systems, this skill guides the "trust the agent's intelligence" philosophy.
|
||||
</p>
|
||||
<h4>Key Patterns</h4>
|
||||
<ul>
|
||||
<li><strong>Prompt-Native Features</strong> - Define features in prompts, not code</li>
|
||||
<li><strong>MCP Tool Design</strong> - Build tools agents can use effectively</li>
|
||||
<li><strong>System Prompts</strong> - Write instructions that guide agent behavior</li>
|
||||
<li><strong>Self-Modification</strong> - Allow agents to improve their own prompts</li>
|
||||
</ul>
|
||||
<h4>Core Principle</h4>
|
||||
<p>Whatever the user can do, the agent can do. Whatever the user can see, the agent can see.</p>
|
||||
<div class="card-code-block">
|
||||
<pre><code>skill: agent-native-architecture</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Content & Workflow -->
|
||||
<section id="content-workflow">
|
||||
<h2><i class="fa-solid fa-pen-fancy"></i> Content & Workflow (3)</h2>
|
||||
<p>Writing, editing, and organizing work. These skills handle everything from style guide compliance to git worktree management—the meta-work that makes the real work easier.</p>
|
||||
|
||||
<div class="skill-detail" id="every-style-editor">
|
||||
<div class="skill-detail-header">
|
||||
<h3>every-style-editor</h3>
|
||||
<span class="skill-badge">Content</span>
|
||||
</div>
|
||||
<p class="skill-detail-description">
|
||||
You wrote a draft, but you're not sure if it matches Every's style guide. Should "internet" be capitalized? Is this comma splice allowed? This skill does a four-phase line-by-line review: context, detailed edits, mechanical checks, and actionable recommendations. It's like having a copy editor who never gets tired.
|
||||
</p>
|
||||
<h4>Four-Phase Review</h4>
|
||||
<ol>
|
||||
<li><strong>Initial Assessment</strong> - Context, type, audience, tone</li>
|
||||
<li><strong>Detailed Line Edit</strong> - Sentence structure, punctuation, capitalization</li>
|
||||
<li><strong>Mechanical Review</strong> - Spacing, formatting, consistency</li>
|
||||
<li><strong>Recommendations</strong> - Actionable improvement suggestions</li>
|
||||
</ol>
|
||||
<h4>Style Checks</h4>
|
||||
<ul>
|
||||
<li>Grammar and punctuation</li>
|
||||
<li>Style guide compliance</li>
|
||||
<li>Capitalization rules</li>
|
||||
<li>Word choice optimization</li>
|
||||
<li>Formatting consistency</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>skill: every-style-editor</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="skill-detail" id="file-todos">
|
||||
<div class="skill-detail-header">
|
||||
<h3>file-todos</h3>
|
||||
<span class="skill-badge">Workflow</span>
|
||||
</div>
|
||||
<p class="skill-detail-description">
|
||||
Your todo list is a bunch of markdown files in a <code>todos/</code> directory. Each filename encodes status, priority, and description. No database, no UI, just files with YAML frontmatter. When you need to track work without setting up Jira, this is the system.
|
||||
</p>
|
||||
<h4>File Format</h4>
|
||||
<div class="card-code-block">
|
||||
<pre><code># Naming convention
|
||||
{issue_id}-{status}-{priority}-{description}.md
|
||||
|
||||
# Examples
|
||||
001-pending-p1-security-vulnerability.md
|
||||
002-ready-p2-performance-optimization.md
|
||||
003-complete-p3-code-cleanup.md</code></pre>
|
||||
</div>
|
||||
<h4>Status Values</h4>
|
||||
<ul>
|
||||
<li><code>pending</code> - Needs triage</li>
|
||||
<li><code>ready</code> - Approved for work</li>
|
||||
<li><code>complete</code> - Done</li>
|
||||
</ul>
|
||||
<h4>Priority Values</h4>
|
||||
<ul>
|
||||
<li><code>p1</code> - Critical</li>
|
||||
<li><code>p2</code> - Important</li>
|
||||
<li><code>p3</code> - Nice-to-have</li>
|
||||
</ul>
|
||||
<h4>YAML Frontmatter</h4>
|
||||
<div class="card-code-block">
|
||||
<pre><code>---
|
||||
status: pending
|
||||
priority: p1
|
||||
issue_id: "001"
|
||||
tags: [security, authentication]
|
||||
dependencies: []
|
||||
---</code></pre>
|
||||
</div>
|
||||
<div class="card-code-block">
|
||||
<pre><code>skill: file-todos</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="skill-detail" id="git-worktree">
|
||||
<div class="skill-detail-header">
|
||||
<h3>git-worktree</h3>
|
||||
<span class="skill-badge">Git</span>
|
||||
</div>
|
||||
<p class="skill-detail-description">
|
||||
You're working on a feature branch, but you need to review a PR without losing your current work. Git worktrees let you have multiple branches checked out simultaneously in separate directories. This skill manages them—create, switch, cleanup—so you can context-switch without stashing or committing half-finished code.
|
||||
</p>
|
||||
<h4>Commands</h4>
|
||||
<div class="card-code-block">
|
||||
<pre><code># Create new worktree
|
||||
bash scripts/worktree-manager.sh create feature-login
|
||||
|
||||
# List worktrees
|
||||
bash scripts/worktree-manager.sh list
|
||||
|
||||
# Switch to worktree
|
||||
bash scripts/worktree-manager.sh switch feature-login
|
||||
|
||||
# Clean up completed worktrees
|
||||
bash scripts/worktree-manager.sh cleanup</code></pre>
|
||||
</div>
|
||||
<h4>Integration</h4>
|
||||
<ul>
|
||||
<li>Works with <code>/review</code> for isolated PR analysis</li>
|
||||
<li>Works with <code>/work</code> for parallel feature development</li>
|
||||
</ul>
|
||||
<h4>Requirements</h4>
|
||||
<ul>
|
||||
<li>Git 2.8+ (for worktree support)</li>
|
||||
<li>Worktrees stored in <code>.worktrees/</code> directory</li>
|
||||
</ul>
|
||||
<div class="card-code-block">
|
||||
<pre><code>skill: git-worktree</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Image Generation -->
|
||||
<section id="image-generation">
|
||||
<h2><i class="fa-solid fa-image"></i> Image Generation (1)</h2>
|
||||
<p>Generate images with AI. Not stock photos you found on Unsplash—images you describe and the model creates.</p>
|
||||
|
||||
<div class="skill-detail featured" id="gemini-imagegen">
|
||||
<div class="skill-detail-header">
|
||||
<h3>gemini-imagegen</h3>
|
||||
<span class="skill-badge highlight">AI Images</span>
|
||||
</div>
|
||||
<p class="skill-detail-description">
|
||||
Need a logo with specific text? A product mockup on a marble surface? An illustration in a kawaii style? This skill wraps Google's Gemini image generation API. You describe what you want, it generates it. You can edit existing images, refine over multiple turns, or compose from reference images. All through simple Python scripts.
|
||||
</p>
|
||||
|
||||
<h4>Features</h4>
|
||||
<div class="skill-features">
|
||||
<div class="feature-item"><i class="fa-solid fa-check"></i> Text-to-image generation</div>
|
||||
<div class="feature-item"><i class="fa-solid fa-check"></i> Image editing & manipulation</div>
|
||||
<div class="feature-item"><i class="fa-solid fa-check"></i> Multi-turn iterative refinement</div>
|
||||
<div class="feature-item"><i class="fa-solid fa-check"></i> Multiple reference images (up to 14)</div>
|
||||
<div class="feature-item"><i class="fa-solid fa-check"></i> Google Search grounding (Pro)</div>
|
||||
</div>
|
||||
|
||||
<h4>Available Models</h4>
|
||||
<table class="docs-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Model</th>
|
||||
<th>Resolution</th>
|
||||
<th>Best For</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>gemini-2.5-flash-image</code></td>
|
||||
<td>1024px</td>
|
||||
<td>Speed, high-volume tasks</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>gemini-3-pro-image-preview</code></td>
|
||||
<td>Up to 4K</td>
|
||||
<td>Professional assets, complex instructions</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<h4>Quick Start</h4>
|
||||
<div class="card-code-block">
|
||||
<pre><code># Text-to-image
|
||||
python scripts/generate_image.py "A cat wearing a wizard hat" output.png
|
||||
|
||||
# Edit existing image
|
||||
python scripts/edit_image.py input.png "Add a rainbow in the background" output.png
|
||||
|
||||
# Multi-turn chat
|
||||
python scripts/multi_turn_chat.py</code></pre>
|
||||
</div>
|
||||
|
||||
<h4>Image Configuration</h4>
|
||||
<div class="card-code-block">
|
||||
<pre><code>from google.genai import types
|
||||
|
||||
response = client.models.generate_content(
|
||||
model="gemini-3-pro-image-preview",
|
||||
contents=[prompt],
|
||||
config=types.GenerateContentConfig(
|
||||
response_modalities=['TEXT', 'IMAGE'],
|
||||
image_config=types.ImageConfig(
|
||||
aspect_ratio="16:9", # 1:1, 2:3, 3:2, 4:3, 16:9, 21:9
|
||||
image_size="2K" # 1K, 2K, 4K (Pro only)
|
||||
),
|
||||
)
|
||||
)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4>Prompting Best Practices</h4>
|
||||
<ul>
|
||||
<li><strong>Photorealistic</strong> - Include camera details: lens type, lighting, angle, mood</li>
|
||||
<li><strong>Stylized Art</strong> - Specify style explicitly: kawaii, cel-shading, bold outlines</li>
|
||||
<li><strong>Text in Images</strong> - Be explicit about font style and placement (use Pro model)</li>
|
||||
<li><strong>Product Mockups</strong> - Describe lighting setup and surface</li>
|
||||
</ul>
|
||||
|
||||
<h4>Requirements</h4>
|
||||
<table class="docs-table">
|
||||
<tr>
|
||||
<td><code>GEMINI_API_KEY</code></td>
|
||||
<td>Required environment variable</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>google-genai</code></td>
|
||||
<td>Python package</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>pillow</code></td>
|
||||
<td>Python package for image handling</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<div class="callout callout-info">
|
||||
<div class="callout-icon"><i class="fa-solid fa-circle-info"></i></div>
|
||||
<div class="callout-content">
|
||||
<p>All generated images include SynthID watermarks. Image-only mode won't work with Google Search grounding.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="card-code-block">
|
||||
<pre><code>skill: gemini-imagegen</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Navigation -->
|
||||
<nav class="docs-nav-footer">
|
||||
<a href="commands.html" class="nav-prev">
|
||||
<span class="nav-label">Previous</span>
|
||||
<span class="nav-title"><i class="fa-solid fa-arrow-left"></i> Commands</span>
|
||||
</a>
|
||||
<a href="mcp-servers.html" class="nav-next">
|
||||
<span class="nav-label">Next</span>
|
||||
<span class="nav-title">MCP Servers <i class="fa-solid fa-arrow-right"></i></span>
|
||||
</a>
|
||||
</nav>
|
||||
</article>
|
||||
</main>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
document.querySelector('[data-sidebar-toggle]')?.addEventListener('click', () => {
|
||||
document.querySelector('.docs-sidebar').classList.toggle('open');
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
Reference in New Issue
Block a user