Write substantive overview.md with architecture diagrams

## Metadata - **Commit Message**: `docs(site): write overview.md with architecture diagrams` - **Branch**: `feature/m3-docs-overview` ## Background and Context `docs/overview.md` currently contains only 19 lines of marketing copy with a demo PlantUML diagram. The overview should provide a substantive architectural description of the system for developers and contributors who need to understand how components relate. ## Expected Behavior A substantive overview document at `docs/overview.md` containing a system architecture description, PlantUML diagrams rendered via Kroki, component relationship explanations, and data flow documentation. The page builds correctly with `bundle exec rake documentation`. ## Acceptance Criteria - [ ] Architecture overview with layer diagram - [ ] Key component descriptions covering all major subsystems - [ ] At least 2 Kroki-rendered diagrams (architecture, data flow) - [ ] Builds correctly with `bundle exec rake documentation` ## Subtasks - [ ] Code: Write `docs/overview.md` with system architecture description, PlantUML diagrams via Kroki, component relationships - [ ] Docs: Ensure diagrams are properly formatted for Kroki rendering - [ ] Tests (Cucumber): Add `tests/unit/docs_overview.feature` covering overview content structure validation. - [ ] Tests (Cucumber Integration): Add integration feature in `tests/integration/` for overview documentation build and diagram rendering. - [ ] Tests (Profiling): Run `bundle exec rake unit_profile` and verify no performance regressions for documentation generation. - [ ] Quality: Verify coverage >=85% via `bundle exec rake unit`. If coverage is <85% then review the current unit test coverage report at `build/tests/unit/coverage/` and use it to write new Cucumber based unit tests to improve code coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun `bundle exec rake unit` to verify all tests pass and coverage is above >=85%. Only mark this as complete once coverage is >=85%, if not repeat this task as many times as is needed until coverage reaches >=85%. - [ ] Quality: Run `bundle exec rake` (default task: unit tests with coverage) and `bundle exec rake integration`, fix any errors if needed ensuring both pass across **entire** code base, do not ignore any failure even if it seems unrelated to this commit, fix it. ## Definition of Done This issue is complete when: - All subtasks above are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata exactly. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged** before this issue is marked done.

freemo commented

2026-03-14 23:57:25 +00:00

Owner

Metadata

Commit Message: docs(site): write overview.md with architecture diagrams
Branch: feature/m3-docs-overview

Background and Context

docs/overview.md currently contains only 19 lines of marketing copy with a demo PlantUML diagram. The overview should provide a substantive architectural description of the system for developers and contributors who need to understand how components relate.

Expected Behavior

A substantive overview document at docs/overview.md containing a system architecture description, PlantUML diagrams rendered via Kroki, component relationship explanations, and data flow documentation. The page builds correctly with bundle exec rake documentation.

Acceptance Criteria

Architecture overview with layer diagram
Key component descriptions covering all major subsystems
At least 2 Kroki-rendered diagrams (architecture, data flow)
Builds correctly with bundle exec rake documentation

Subtasks

Code: Write docs/overview.md with system architecture description, PlantUML diagrams via Kroki, component relationships
Docs: Ensure diagrams are properly formatted for Kroki rendering
Tests (Cucumber): Add tests/unit/docs_overview.feature covering overview content structure validation.
Tests (Cucumber Integration): Add integration feature in tests/integration/ for overview documentation build and diagram rendering.
Tests (Profiling): Run bundle exec rake unit_profile and verify no performance regressions for documentation generation.
Quality: Verify coverage >=85% via bundle exec rake unit. If coverage is <85% then review the current unit test coverage report at build/tests/unit/coverage/ and use it to write new Cucumber based unit tests to improve code coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun bundle exec rake unit to verify all tests pass and coverage is above >=85%. Only mark this as complete once coverage is >=85%, if not repeat this task as many times as is needed until coverage reaches >=85%.
Quality: Run bundle exec rake (default task: unit tests with coverage) and bundle exec rake integration, fix any errors if needed ensuring both pass across entire code base, do not ignore any failure even if it seems unrelated to this commit, fix it.

Definition of Done

This issue is complete when:

All subtasks above are completed and checked off.
A Git commit is created where the first line of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation.
The commit is pushed to the remote on the branch matching the Branch in Metadata exactly.
The commit is submitted as a pull request to master, reviewed, and merged before this issue is marked done.