Add docs index and per-skill docs, link from main README

This commit is contained in:
2026-02-09 05:06:13 +00:00
parent 1ba911c3fb
commit 9ddc17b228
4 changed files with 83 additions and 10 deletions

View File

@@ -15,7 +15,10 @@ This repo is organized similarly to `obra/superpowers` and is designed to scale
ai-coding-skills/
├── README.md
├── docs/
── INSTALL.md
── README.md
│ ├── INSTALL.md
│ ├── CREATE-PLAN.md
│ └── WEB-AUTOMATION.md
├── skills/
│ ├── _template/
│ │ └── SKILL.md
@@ -38,16 +41,17 @@ ai-coding-skills/
## Skills
| Skill | Agent Variant | Purpose | Status |
|---|---|---|---|
| create-plan | codex | Structured planning with milestones + runbook-first execution workflow | Ready |
| create-plan | claude-code | Structured planning with milestones + runbook-first execution workflow | Ready |
| create-plan | opencode | Structured planning with milestones + runbook-first execution workflow | Ready |
| web-automation | codex | Playwright + Camoufox browsing/scraping/auth automation | Ready |
| web-automation | claude-code | Playwright + Camoufox browsing/scraping/auth automation | Ready |
| web-automation | opencode | Playwright + Camoufox browsing/scraping/auth automation | Ready |
| Skill | Agent Variant | Purpose | Status | Docs |
|---|---|---|---|---|
| create-plan | codex | Structured planning with milestones + runbook-first execution workflow | Ready | [CREATE-PLAN](docs/CREATE-PLAN.md) |
| create-plan | claude-code | Structured planning with milestones + runbook-first execution workflow | Ready | [CREATE-PLAN](docs/CREATE-PLAN.md) |
| create-plan | opencode | Structured planning with milestones + runbook-first execution workflow | Ready | [CREATE-PLAN](docs/CREATE-PLAN.md) |
| web-automation | codex | Playwright + Camoufox browsing/scraping/auth automation | Ready | [WEB-AUTOMATION](docs/WEB-AUTOMATION.md) |
| web-automation | claude-code | Playwright + Camoufox browsing/scraping/auth automation | Ready | [WEB-AUTOMATION](docs/WEB-AUTOMATION.md) |
| web-automation | opencode | Playwright + Camoufox browsing/scraping/auth automation | Ready | [WEB-AUTOMATION](docs/WEB-AUTOMATION.md) |
See install instructions: `docs/INSTALL.md`
- Docs index: `docs/README.md`
- Install guide: `docs/INSTALL.md`
## Compatibility Policy

27
docs/CREATE-PLAN.md Normal file
View File

@@ -0,0 +1,27 @@
# CREATE-PLAN
## Purpose
Create structured implementation plans with milestone and story tracking.
## Key Behavior
- Requires Superpowers dependencies (`brainstorming`, `writing-plans`).
- Creates plans under `ai_plan/YYYY-MM-DD-<short-title>/`.
- Ensures `/ai_plan/` is in `.gitignore`.
- Commits `.gitignore` update locally when added.
- Produces:
- `original-plan.md`
- `final-transcript.md`
- `milestone-plan.md`
- `story-tracker.md`
- `continuation-runbook.md`
## Execution Workflow Rules
- Read runbook first.
- Complete one milestone at a time.
- Lint/typecheck/test (changed files first).
- Commit (do not push), ask for feedback, apply feedback, commit again.
- Move to next milestone only after approval.
- Ask permission before final push.

9
docs/README.md Normal file
View File

@@ -0,0 +1,9 @@
# Skills Documentation
This directory contains user-facing docs for each skill.
## Index
- [CREATE-PLAN.md](./CREATE-PLAN.md) — Planning workflow, milestones, feedback loop, and `ai_plan/` conventions.
- [WEB-AUTOMATION.md](./WEB-AUTOMATION.md) — Playwright + Camoufox setup, dependency checks, and usage examples.
- [INSTALL.md](./INSTALL.md) — Installation guide for all supported agent variants.

33
docs/WEB-AUTOMATION.md Normal file
View File

@@ -0,0 +1,33 @@
# WEB-AUTOMATION
## Purpose
Automate browsing and scraping with Playwright + Camoufox.
## Requirements
- Node.js 20+
- pnpm
- `playwright-core`
- `camoufox-js`
## Setup Summary
1. Install skill files for your agent.
2. `cd .../skills/web-automation/scripts`
3. `pnpm install`
4. `pnpm add playwright-core camoufox-js`
5. `npx camoufox-js fetch`
## Dependency Checks
```bash
node -e "require.resolve('playwright-core/package.json');require.resolve('camoufox-js/package.json');console.log('OK: playwright-core + camoufox-js installed')"
node -e "const fs=require('fs');const t=fs.readFileSync('browse.ts','utf8');if(!/camoufox-js/.test(t)){throw new Error('browse.ts is not configured for Camoufox')}console.log('OK: Camoufox integration detected in browse.ts')"
```
## Usage Examples
- Browse: `npx tsx browse.ts --url "https://example.com"`
- Scrape: `npx tsx scrape.ts --url "https://example.com" --mode main --output page.md`
- Auth: `npx tsx auth.ts --url "https://example.com/login"`