99d13e6e4a
- 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
45 lines
2.0 KiB
Markdown
45 lines
2.0 KiB
Markdown
<!-- ai-superpower:template -->
|
|
|
|
> **AI: remove the marker line above (`<!-- ai-superpower:template -->`) immediately — in the same edit where you first touch this file, before anything else.**
|
|
> As long as that line exists, `apply.sh` will overwrite this file on every run.
|
|
|
|
# <project name> — AI context
|
|
|
|
> **Quickstart:** let the AI write this for you. Open the project in your editor and prompt:
|
|
>
|
|
> *"Read the codebase and write docs/ai-context.md for this project. Cover: what it does, the tech stack, architecture, key decisions, conventions, and anything else an AI needs to work here effectively."*
|
|
>
|
|
> Review, correct, and commit. You own this file — the AI drafts it.
|
|
|
|
## What this project does
|
|
|
|
> 2-4 sentences. What problem does this solve, who uses it, and what does it NOT do?
|
|
|
|
## Stack
|
|
|
|
> Languages, frameworks, key libraries, infrastructure — include versions where they matter.
|
|
|
|
## Architecture overview
|
|
|
|
> Link to docs/architecture.md. Do not duplicate content from there.
|
|
> Example: _See [docs/architecture.md](architecture.md)._
|
|
>
|
|
> **Monorepo — AI:** scan the repo structure. If you find multiple services, apps, or components under separate subdirectories, tell the developer:
|
|
> - which subdirectories you identified as separate components
|
|
> - that each one should have its own `docs/ai-context.md` and `docs/architecture.md`
|
|
> - offer to create them one by one
|
|
>
|
|
> **Monorepo — developer:** if this repo contains multiple services or components, create a `docs/` folder in each one and ask the AI to write `ai-context.md` and `architecture.md` there. Link to them from this file.
|
|
|
|
## Key decisions
|
|
|
|
> Decisions that affect how the code is written and why. Especially anything that would surprise a new team member.
|
|
|
|
## Conventions
|
|
|
|
> How is code organised? What patterns are used consistently? What would a new developer get wrong on their first PR?
|
|
|
|
## What AI should know
|
|
|
|
> Context that affects how the AI should work here: frozen modules, deployment constraints, external dependencies, things to avoid.
|