niko/ai-superpower
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
5955a27f08
ai-superpower/.ai/instructions/behavior
History
moilanik 5955a27f08 docs(core-principles): add read-before-edit and explain-as-you-go rules
2026-03-18 08:27:36 +02:00
..
core-principles.instructions.md docs(core-principles): add read-before-edit and explain-as-you-go rules 2026-03-18 08:27:36 +02:00
docs.instructions.md feat: configurable docs folders + mandatory instructions rules 2026-03-06 09:42:48 +02:00
project-context.instructions.md feat: configurable docs folders + mandatory instructions rules 2026-03-06 09:42:48 +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.