Developer Notes
Practical, working-level documentation for the team: how-to guides for common tasks and rituals that describe how we run sessions and keep shared context.
Unlike ADRs (which record why a decision was made and are immutable once accepted), developer notes are living documents. Update them freely as our tools and practices evolve.
What goes here
- How-to's — step-by-step task recipes (e.g. local rebuild, exporting config, adding a custom module, running the docs site).
- Rituals — the shared team practices that keep everyone's context in sync (session start/end, ADR/spike/deferred flushing, session logs).
Naming convention
| Type | Pattern | Example |
|---|---|---|
| How-to | howto-short-description.md |
howto-run-docs-locally.md |
| Ritual | rituals-short-description.md |
rituals-session-workflow.md |
When adding a file, also list it in .pages (new files are invisible in mkdocs
until added there) and add a row to the index below.
Index
| File | Type | Summary |
|---|---|---|
| rituals-session-workflow.md | Ritual | Session start/end rituals and shared-context discipline |
| howto-local-dev.md | How-to | Local development & rebuilds with DDEV; config workflow |
| howto-run-docs-locally.md | How-to | Preview and build this docs site locally |
| howto-template.md | Template | Starting point for new how-to guides |