Skip to content

Documentation Map

Use this map to load the right files. Agents MUST follow AGENTS.md at the repository root.

New human engineers: start with guides/onboarding.md.

Normative (latest rules)

PathPurpose
conventions/MUST/MUST NOT rules and code examples (purpose-based filenames, no numeric prefix)
conventions/shared/security-controls.mdOWASP matrix, CI security gates, enforcement matrix
conventions/shared/api-compatibility.mdOpenAPI diff and breaking-change policy
conventions/backend/object-authorization.mdBOLA prevention and auth test matrix
conventions/backend/api-acceptance-tests.mdReqnroll, @usecase: / @ac: tags
conventions/backend/external-dependencies.mdWireMock.Net, Respawn
architecture/clean-architecture.mdLayer diagram and dependency rules
glossary.mdADDD-specific terms
guides/agentic-domain-driven-design.mdDomain doc tree, intellectual lineage
guides/write-use-case-doc.mdAuthoring operation and test specs
guides/add-new-use-case.mdImplementation playbook
guides/definition-of-done.mdCompletion checklist
guides/create-new-project.mdGreenfield monorepo setup

Convention paths are also listed in standards.manifest.jsonconventionIndex.

Domain documentation (consumer projects)

Living source of truth under docs/domain/ in each project:

LevelPathRole
Systemdocs/domain/README.mdIndex of features, use cases, doc status
Featuredocs/domain/{feature}/README.mdAggregate, ubiquitous language, invariants
Operationdocs/domain/{feature}/{use-case}.mdBehavior, endpoints, HTTP contract
Test specdocs/domain/{feature}/{use-case}.tests.mdTest Coverage table, variations

Templates: templates/docs/. Config scaffolds: templates/config/.

Reference implementation (consumer project)

LitePress implements these standards end to end. Study it alongside templates and blueprints when building a similar stack.

Decisions (why, not what)

PathPurpose
decisions/README.mdIndex with status, concern tags, canonical conventions
decisions/*.mdRationale; do not load for routine coding

Templates and blueprints

PathPurpose
templates/README.mddocs vs config split
blueprints/README.mdComplete Program.cs, endpoints, acceptance tests
runbooks/README.mdOperational procedures

Reference (humans only)

PathPurpose
philosophy.mdLong-form architecture rationale
agentic-development.mdWhy standards are agent-first