docs

name	docs
description	Manage documentation with modes and templates (Docs Manager Agent)

📚 DOCS MANAGER AGENT

Documentation task:

Task: {{args}}

MODE DETECTION

Mode	Trigger	Action
INIT	"init", "setup"	Create full docs suite
UPDATE	"update", "sync"	Scan git diff → update
SUMMARIZE	"summarize", "overview"	Generate codebase summary
API	"api", "endpoint"	API reference docs

---

INIT MODE - Create Docs Suite

./docs/
├── README.md                  # Project overview
├── project-overview.md        # Requirements, roadmap
├── code-standards.md          # Conventions, patterns
├── codebase-summary.md        # Generated overview
├── system-architecture.md     # Technical design
├── deployment-guide.md        # Production setup
├── design-guidelines.md       # UI/UX specs
└── api-reference.md           # API documentation

---

UPDATE MODE - Git Diff Scan

1. Check recent changes:

git diff --name-only HEAD~5

2. Identify affected docs:

• New files → Add to codebase-summary
• API changes → Update api-reference
• Config changes → Update deployment-guide

3. Update CHANGELOG.md:

## [Unreleased]
### Added
- Feature X (PR #123)
### Changed
- Updated Y

---

API MODE - Reference Template

Template:

## POST /api/auth/login

Authenticate user and return JWT token.

### Request
```json
{
  "email": "[e-mail]",
  "password": "securepass123"
}

Response (200)

{
  "token": "eyJhbGciOiJIUzI1NiIs...",
  "expiresIn": 3600
}

Errors

Code	Message
400	Invalid request format
401	Invalid credentials
429	Rate limit exceeded

cURL Example

curl -X POST https://api.example.com/auth/login -H "Content-Type: application/json" -d '{"email": "[e-mail]", "password": "pass"}'

# ---

## ARCHITECTURE MODE - ASCII Diagrams

```ascii
┌─────────────┐     ┌─────────────┐     ┌─────────────┐
│   Client    │────▶│   API GW    │────▶│   Service   │
└─────────────┘     └─────────────┘     └─────────────┘
                           │                   │
                           ▼                   ▼
                    ┌─────────────┐     ┌─────────────┐
                    │    Auth     │     │   Database  │
                    └─────────────┘     └─────────────┘

---

VALIDATION CHECKLIST

• Links - All internal links work
• Code examples - All code runs
• Formatting - Consistent markdown
• Naming - camelCase/PascalCase/snake_case correct
• Completeness - No TODO/FIXME left

---

WORKFLOW

# After feature
git commit -m "feat: add auth"
/docs update
git add docs/ && git commit -m "docs: update for auth"

# Weekly maintenance
/docs update
/docs summarize  # Monthly

Key Takeaway: Keep docs synchronized with code. Run after every feature, validate weekly.