glm-5.1
67ccfbf928
- Create decisions/ directory with 32 numbered ADRs (ADR-001 through ADR-032) extracted from inline DD/SD/ED/SE decision sections - Create open-questions.md with 16 OQs organized by theme, cross-referenced to ADRs, with status tracking (resolved/open) - Create README.md as architecture index with doc table, ADR table, and lifecycle status definitions (draft/reviewed/stable/deprecated) - Replace inline decision sections in all spec docs with ADR reference tables - Replace inline open questions with OQ references to centralized tracker - Update frontmatter: metagraph-module.md, overview.md, sqlite-host.md → reviewed; schema-evolution.md and encrypted-data.md remain draft - DD1-DD10 → ADR-009 through ADR-018 - D1-D8 → ADR-001 through ADR-008 - SD1-SD5 → ADR-019 through ADR-023 (SD5 folded into ADR-006/008) - ED1-ED5 → ADR-023 through ADR-027 - SE1-SE5 → ADR-028 through ADR-032
23 lines
692 B
Markdown
23 lines
692 B
Markdown
# ADR-007: No comments in code
|
|
|
|
## Status
|
|
|
|
Accepted
|
|
|
|
## Context
|
|
|
|
Per project convention across @alkdev packages, inline comments in source files create maintenance burden and often go stale. Documentation belongs in architecture docs and TypeBox schema descriptions.
|
|
|
|
## Decision
|
|
|
|
Source files contain no inline comments. Documentation lives in architecture docs (`docs/architecture/`) and TypeBox schema `description` properties.
|
|
|
|
## Consequences
|
|
|
|
- Code is self-documenting through naming and structure
|
|
- All rationale and context lives in versioned architecture docs
|
|
- TypeBox schemas can carry `description` fields for runtime documentation
|
|
|
|
## References
|
|
|
|
- [overview.md](../overview.md) |