102f593909
config.yaml: new repo-root config file with docs_folders list (docs, documentation, doc). apply.sh reads this list and picks the first existing folder per project instead of hardcoding docs/. Instructions: - core-principles: add No Vibe Coding and No Touching .ai/ sections - ai-root-instructions: add mandatory instructions block — rules stay active for the whole session, not just at start; AI must stop and announce if instructions were not loaded - project-context, docs: updated to list all docs folder alternatives and reference config.yaml as the source of truth FR-5.0 added to apply-requirements.md. README step 4 updated. |
||
|---|---|---|
| .. | ||
| core-principles.instructions.md | ||
| docs.instructions.md | ||
| project-context.instructions.md | ||
| 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
- What is this? — the problem and solution in plain language
- How to run locally — minimal commands only, no theory
- 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:
- What problem does this project solve?
- 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.