Skip to content

docs(samples): add concrete sample content to all template documents#107

Merged
nullhack merged 1 commit intomainfrom
docs/sample-documents
Apr 22, 2026
Merged

docs(samples): add concrete sample content to all template documents#107
nullhack merged 1 commit intomainfrom
docs/sample-documents

Conversation

@nullhack
Copy link
Copy Markdown
Owner

Summary

  • Add filled sample content to all placeholder template documents (system.md, glossary.md, discovery.md, scope_journal.md, two ADRs) using the display-version feature as the concrete example throughout
  • Consolidate C4 Context and Container diagrams into system.md as ## Context and ## Container sections (SA-owned); delete standalone docs/context.md and docs/container.md
  • Carry forward previously staged workflow and skill improvements (AGENTS.md, FLOW.md, agent and skill files)

Changes

  • docs/system.md — full rewrite: Summary, Actors, Structure, Key Decisions, External Dependencies, Active Constraints, Domain Model (Entities, Actions, Relationships), C4 Context Mermaid, C4 Container Mermaid, ADR Index, Completed Features
  • docs/glossary.md — new file with five domain terms from display-version
  • docs/adr/ADR-2026-04-22-version-source.md — new ADR: read version from pyproject.toml via tomllib
  • docs/adr/ADR-2026-04-22-verbosity-validation.md — new ADR: validate verbosity against closed set
  • docs/discovery.md, docs/scope_journal.md — concrete session entries for display-version
  • docs/context.md, docs/container.md — deleted; content consolidated into system.md
  • docs/index.html — "Context Diagram" card updated to link system.md#context
  • WORK.md — correction entry appended to session log

Reviewer Notes

No code changes. All changes are documentation and workflow template files. The display-version feature (already in completed/) is used as the reference example across all documents so every placeholder has a realistic, internally consistent value.

- Rewrite docs/system.md with full SA-owned structure: Summary, Actors,
  Structure, Key Decisions, External Dependencies, Active Constraints,
  Domain Model (Entities, Actions, Relationships), Context (C4L1 Mermaid),
  Container (C4L2 Mermaid), ADR Index, Completed Features
- Add docs/glossary.md with five domain terms from display-version feature
- Add docs/adr/ADR-2026-04-22-version-source.md and verbosity-validation.md
- Fill docs/discovery.md, docs/scope_journal.md with display-version session
- Remove standalone docs/context.md and docs/container.md — consolidated
  into system.md as ## Context and ## Container sections
- Update docs/index.html: context.md card → system.md#context (C4 Diagrams)
- Update WORK.md: append correction entry for domain-model.md/context.md refs
- Carry forward previously staged workflow and skill improvements
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant