Stefano Fiorini
44 lines
2.9 KiB
Markdown
44 lines
2.9 KiB
Markdown
# Skills Documentation
|
|
|
|
This directory contains user-facing docs for each skill.
|
|
|
|
## Recommended Reading Flow
|
|
|
|
1. Use [INSTALLER.md](./INSTALLER.md) for the guided install/update/remove wizard (`./scripts/manage-skills.sh`).
|
|
2. Use the client docs ([CODEX.md](./CODEX.md), [CLAUDE-CODE.md](./CLAUDE-CODE.md), [CURSOR.md](./CURSOR.md), [OPENCODE.md](./OPENCODE.md)) for manual installs, and [PI.md](./PI.md) for Pi overview, package install, and manual single-skill copy.
|
|
3. Use the skill docs below for skill-specific requirements, runtime setup, verification, and examples.
|
|
4. For Pi workflow skills, also consult [PI-SUPERPOWERS.md](./PI-SUPERPOWERS.md) and [PI-COMMON-REVIEWER.md](./PI-COMMON-REVIEWER.md).
|
|
|
|
## Index
|
|
|
|
- [INSTALLER.md](./INSTALLER.md) — Skill manager wizard for installing, updating/reinstalling, and removing repo skills across supported clients.
|
|
- [CODEX.md](./CODEX.md) — Manual install instructions for Codex variants.
|
|
- [CLAUDE-CODE.md](./CLAUDE-CODE.md) — Manual install instructions for Claude Code variants.
|
|
- [CURSOR.md](./CURSOR.md) — Manual install instructions for Cursor variants.
|
|
- [OPENCODE.md](./OPENCODE.md) — Manual install instructions for OpenCode variants.
|
|
- [ATLASSIAN.md](./ATLASSIAN.md) — Includes requirements, generated bundle sync, install, auth, safety rules, and usage examples for the Atlassian skill.
|
|
- [CREATE-PLAN.md](./CREATE-PLAN.md) — Includes requirements, install, verification, and execution workflow for create-plan.
|
|
- [DO-TASK.md](./DO-TASK.md) — Single-prompt end-to-end execution with dual reviewer loops (plan + implementation), TDD-first, single task commit. Sibling of create-plan/implement-plan scoped to ad-hoc tasks.
|
|
- [IMPLEMENT-PLAN.md](./IMPLEMENT-PLAN.md) — Includes requirements, install, verification, and milestone review workflow for implement-plan.
|
|
- [PI.md](./PI.md) — Pi support overview, source-vs-package layout, install flow, and extension decision.
|
|
- [PI-RESEARCH.md](./PI-RESEARCH.md) — Source-backed pi findings that inform the repo's pi variants and packaging choices.
|
|
- [PI-SUPERPOWERS.md](./PI-SUPERPOWERS.md) — How to install or verify Obra Superpowers for Pi.
|
|
- [PI-COMMON-REVIEWER.md](./PI-COMMON-REVIEWER.md) — How to install or verify the shared reviewer-runtime helpers for Pi workflow skills.
|
|
- [TELEGRAM-NOTIFICATIONS.md](./TELEGRAM-NOTIFICATIONS.md) — Shared Telegram notification setup used by reviewer-driven skills.
|
|
- [WEB-AUTOMATION.md](./WEB-AUTOMATION.md) — Includes requirements, install, dependency verification, and usage examples for web-automation.
|
|
|
|
## Development
|
|
|
|
- [DEVELOPMENT.md](./DEVELOPMENT.md) — prerequisites, `pnpm run check`, workspace policy,
|
|
and the transitional quality contract.
|
|
- [CLEANUP-BASELINE.md](./CLEANUP-BASELINE.md) — as-is quality baseline captured at M1.
|
|
|
|
## Repo Setup
|
|
|
|
Clone the repo first:
|
|
|
|
```bash
|
|
git clone https://git.fiorinis.com/Home/ai-coding-skills.git
|
|
cd ai-coding-skills
|
|
```
|