niko/ai-superpower
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
93b859f508
ai-superpower/.ai/instructions/behavior
History
moilanik 99d13e6e4a feat: complete apply.sh v1 — summary, guard, dev root install, updated docs 
- apply.sh: direct-run guard (only curl | bash allowed)
- apply.sh: DEV_ROOT passed as explicit arg from bootstrap
- apply.sh: .ai/ copied to dev root as real folder; projects symlink there
- apply.sh: counters + detailed summary (version prev→new, templated, refreshed, no-docs)
- apply.sh: find errors silenced, no crash on empty dev root
- .ai-superpower: added warning comment about deletion side effects
- .gitignore: .ai-instructions.conf → .ai-superpower.version
- scripts/: removed (hello.sh, scan-projects-with-git.sh, verify-docs-folder.sh, add-ai-context-to-docs-folder.sh)
- templates: monorepo sections split into AI instructions + developer instructions
- README.md: rewritten to match current architecture and behaviour
- docs/apply-requirements.md: FR-2.4, FR-3, FR-5, FR-6, FR-7, FR-8 updated
- docs/apply-usecases.md: full detailed Mermaid flowchart replacing placeholder
2026-03-03 11:19:35 +02:00
..
core-principles.instructions.md nit: ai-superpower initial commit 2026-03-02 14:06:36 +02:00
docs.instructions.md feat: complete apply.sh v1 — summary, guard, dev root install, updated docs 2026-03-03 11:19:35 +02:00
project-context.instructions.md nit: ai-superpower initial commit 2026-03-02 14:06:36 +02:00
readme.instructions.md nit: ai-superpower initial commit 2026-03-02 14:06:36 +02:00

readme.instructions.md

README Instructions

For writing style, diagrams and workflow: see documentation.instructions.md

Purpose

README is the entry point for both humans and AI. Start with the problem the project solves — one or two sentences.

Required Sections

  1. What is this? — the problem and solution in plain language
  2. How to run locally — minimal commands only, no theory
  3. Key links — links to docs/ files, nothing else

Rules

  • Keep under ~100 lines — if more is needed, it belongs in docs/
  • No duplication of docs content — link instead
  • Written in English

If README Is Missing

Ask the user:

  1. What problem does this project solve?
  2. How is it started locally?

Do not invent content.

If README Is Outdated

Point out specifically what is wrong. Fix only that — do not rewrite the whole file.