niko/ai-superpower
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
0a3c0cc906
ai-superpower/.ai/instructions/behavior/docs.instructions.md
moilanik a6eb4da214 nit: ai-superpower initial commit 
- .ai/ instruction set (root, behavior, skills, constraints)
- apply.sh workflow documentation (apply.md)
- architecture documentation (docs/architecture.md)
- .github/copilot-instructions.md for VS Code auto-load
- .gitignore (tmp/, .ai-instructions.conf)"
2026-03-02 14:06:36 +02:00

878 B
Raw Blame History

Docs Folder Instructions

Required Files

File Audience Purpose
docs/ai-context.md AI Project context — architecture, decisions, pitfalls
docs/architecture.md Human + AI System overview with Mermaid diagrams

ai-context.md

Contains everything AI needs to avoid bad suggestions:

  • What the system does
  • Key components and their relationships
  • Technical decisions and why they were made
  • What NOT to do (pitfalls, constraints)

Keep under 200 lines. Link to architecture.md for diagrams.

architecture.md

  • Start with a Mermaid diagram
  • Explain components and data flows
  • Written in English

Rules

  • Docs are not a changelog — no "updated X on date Y"
  • If a doc exceeds ~150 lines, split it
  • If asked to document something, put it in docs/ — not README, not inline comments