Make the LLM read architecture docs before making changes

This commit is contained in:
Claudio Ortolina
2026-05-18 06:49:38 +01:00
parent 4ae55ea0ad
commit d41c6e32b0
+5 -2
View File
@@ -16,9 +16,12 @@ The project uses [mise](https://mise.jdx.dev/) to manage high level configuratio
@docs/available-tasks.md
## When to read each reference
## Required first step
Before exploring the codebase for any task, read `docs/architecture.md`. Do this before running file searches, opening source files, or inspecting implementation details so the system boundaries and data flow are in context.
## When to read additional references
- **Read `docs/architecture.md`** before adding/removing modules, schemas, contexts, workers, routes, or external API integrations. Also read it when asked about the supervision tree, database layout, PubSub topics, or how any two parts of the system connect.
- **Read `docs/project-conventions.md`** before writing or refactoring code. Also read it when asked about project style, testing patterns, error handling, SQL optimization, commit messages, or JavaScript conventions.
- **Read `docs/production-infrastructure.md`** before changing deployment config, CI/CD, environment variables, Dockerfiles, or backup strategy. Also read it when asked about hosting, Litestream, Coolify, or production monitoring.
- **Read `docs/available-tasks.md`** before running mise tasks. Read the file to see available tasks, then run `mise run <task> --help` for task-specific options.