diff --git a/AGENTS.md b/AGENTS.md index 60ae67d..127bf9f 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -55,12 +55,37 @@ This snippet demonstrates safe initialization but does **not** itself write `AGE Before making any application changes: -- Read `README.md`, `TESTING.md`, and relevant documentation in `docs/`. +- Read `README.md`, `TESTING.md`, and the relevant documentation in `docs/` (see **Documentation map** below). - Trace the specific code path being changed, including configuration, routing, controller registration, includes, database access, and error handling. - Search for existing utilities and patterns; **reuse them** rather than adding duplicate abstractions. - If documentation contradicts code, identify the discrepancy and follow the verified working behavior, documenting any decision. - Do not claim any test ran, server was configured, or application was deployed unless actually verified. +## Documentation map + +The `docs/` folder is not loaded automatically. Use this table to decide which documents to read for a task; read only what the task needs. Docs in `docs/` were generated from the original starter and may describe the starter rather than this app — verify against code. + +| When the task involves… | Read | +| --- | --- | +| Writing or reviewing any VBScript/ASP code | `docs/AGENTS.md` (detailed coding standards: variants, Null/Empty/Nothing, SQL, encoding, error handling, layers, naming) | +| Agent workflow, self-review, static-analysis checklist | `docs/CLAUDE.md` | +| Orientation / first look at the project | `docs/index.md`, `docs/project-overview.md` | +| Request flow, routing, layers, framework internals | `docs/architecture.md`, `docs/architecture-patterns.md` | +| Adding a feature (controller, model, repository, migration) | `docs/development-guide.md`, `docs/development-instructions.md` | +| Routes and HTTP endpoints | `docs/api-contracts-mvc-starter.md` | +| Database, POBOs, migrations | `docs/data-models-mvc-starter.md` | +| Session/Application state | `docs/state-management-patterns-mvc-starter.md` | +| Views, layout, UI components | `docs/ui-component-inventory-mvc-starter.md`, `docs/component-inventory.md` | +| Where files live / what a folder is for | `docs/source-tree-analysis.md`, `docs/critical-folders-summary.md`, `docs/project-structure.md` | +| Libraries, providers, runtime versions | `docs/technology-stack.md` | +| IIS deployment or `web.config` changes | `docs/deployment-guide.md`, `docs/deployment-configuration.md` (see Deployment guardrails below) | +| Testing | `TESTING.md` | +| Windows Script Host / COM techniques | `docs/Windows scripting secrets.pdf` (reference book; search, don't read whole) | + +`docs/ideas.md`, `docs/project-parts.json`, `docs/project-scan-report.json`, and `docs/existing-documentation-inventory.md` are planning/scan artifacts, not instructions. + +**Precedence:** This root `AGENTS.md` overrides `docs/AGENTS.md` and `docs/CLAUDE.md` where they conflict (for example, their service-layer rules — this app currently has no `app/services/` — or databases other than the configured one). Their own "this file is primary" wording applies only beneath this file. Explicit user instructions and security requirements still come first. + ## Known RouteKit layout and conventions The starter README identifies this structure: