DentalPin Documentation

Index for /docs. Pick a folder by type of doc, never drop new files at this root.

Folder taxonomy

Folder	What lives here
`user-manual/`	End-user / administrator how-to guides (Spanish, screenshots, step-by-step).
`features/`	Product feature specs — what and why (PM-facing). UX briefs, product flows.
`technical/`	Cross-cutting technical reference — how. Auth, events, RBAC, API conventions, module-author guide, tech plans.
`modules/`	Per-module deep-dives. One file (or subfolder) per module.
`adr/`	Architecture Decision Records. Immutable, numbered, never deleted (only superseded).
`checklists/`	Agent / contributor checklists (e.g. new-module bootstrap).
`diagrams/`	Mermaid / PlantUML diagram sources.
`screenshots/`	Image assets (PNG / SVG). No markdown.
`workflows/`	Operational runbooks and end-to-end workflow walkthroughs.

File	Purpose
`README.md`	This index.
`glossary.md`	Bilingual ES↔EN domain terms.
`events-catalog.md`	Auto-generated event catalog. Do not edit.
`modules-catalog.md`	Auto-generated module catalog. Do not edit.

Adding any other .md at this root is a CI failure (see scripts/check_docs_layout.py).

Is it auto-generated? → docs/ root, suffix -catalog.md. Update backend/scripts/generate_catalogs.py.
Is it an architectural decision (rule + rationale + consequences)? → adr/NNNN-title.md.
Is it scoped to one module? → modules/<module>.md (or modules/<module>/).
Is it a checklist / bootstrap recipe for contributors? → checklists/.
Is it a diagram source file (Mermaid / PlantUML)? → diagrams/.
Is it an image? → screenshots/.
Is it an operational runbook (deploy, backup, incident, end-to-end workflow)? → workflows/.
Is it written for end-users or admins (how to use the product)? → user-manual/.
Is it a product feature spec or UX brief (what we're building and why)? → features/.
Otherwise — cross-cutting technical reference or implementation plan → technical/.