docs(architecture): README + .TODO stubs for chip-block / board-block diagrams #67

Merged

navigator merged 1 commit from auto/issue-58-20260525T203246Z_issue58 into main

2026-05-25 17:38:46 -03:00

navigator commented

2026-05-25 17:35:54 -03:00

Owner

Closes #58

What

Scaffold docs/architecture/ for PLAN.md Section 10 deliverables #6 and #7:

docs/architecture/README.md — directory index, scope per diagram, replace-with-.svg ritual
docs/architecture/chip-block.svg.TODO — required content for the single-die PopSoC v1 diagram (drawn from ADR-001..ADR-007 + Section 13.3 PHY interface)
docs/architecture/board-block.svg.TODO — required content for the 8-SoC board diagram (drawn from ADR-008..ADR-014)

Also removes the two pre-existing text-content files named *.svg — they were invalid SVGs that broke any viewer opening them; the issue exists specifically to replace them with .TODO text placeholders.

Why

The Section 10 deliverables are SVG block diagrams that require actual drawing work. Until a contributor draws them, the placeholders should be honest text describing the intended scope, not pseudo-SVGs. The .TODO suffix:

prevents tools that auto-render or thumbnail SVGs from choking on garbage
documents the target so the drawing work, when it happens, has a clear scope
gives a trivial promotion step (git mv *.TODO-out + paste the rendered SVG)

Pure scaffolding — no design decisions made here.

Verification

New files: 217 lines total, all under docs/architecture/
No off-limits paths touched (ADR-017 clean)
Pre-commit hook passed under swarm@pop.coop author

Closes #58 ## What Scaffold `docs/architecture/` for PLAN.md Section 10 deliverables #6 and #7: - `docs/architecture/README.md` — directory index, scope per diagram, replace-with-`.svg` ritual - `docs/architecture/chip-block.svg.TODO` — required content for the single-die PopSoC v1 diagram (drawn from ADR-001..ADR-007 + Section 13.3 PHY interface) - `docs/architecture/board-block.svg.TODO` — required content for the 8-SoC board diagram (drawn from ADR-008..ADR-014) Also removes the two pre-existing text-content files named `*.svg` — they were invalid SVGs that broke any viewer opening them; the issue exists specifically to replace them with `.TODO` text placeholders. ## Why The Section 10 deliverables are SVG block diagrams that require actual drawing work. Until a contributor draws them, the placeholders should be honest text describing the intended scope, not pseudo-SVGs. The `.TODO` suffix: - prevents tools that auto-render or thumbnail SVGs from choking on garbage - documents the target so the drawing work, when it happens, has a clear scope - gives a trivial promotion step (`git mv *.TODO`-out + paste the rendered SVG) Pure scaffolding — no design decisions made here. ## Verification - New files: 217 lines total, all under `docs/architecture/` - No off-limits paths touched (ADR-017 clean) - Pre-commit hook passed under `swarm@pop.coop` author

navigator added 1 commit

2026-05-25 17:35:54 -03:00

docs(architecture): README + .TODO stubs for chip-block / board-block diagrams

build / scalafmt-check (pull_request) Successful in 4s

Details

build / sbt-compile (pull_request) Successful in 3s

Details

build / shell-lint (pull_request) Successful in 1m53s

Details

d53a8b8013

PLAN.md Section 10 deliverables #6 and #7 are SVG block diagrams that
require actual drawing work. Until those exist, the repo carried two
text-content files named *.svg, which are invalid SVGs and break any
viewer that opens them.

Replace the pseudo-SVGs with .TODO text placeholders that enumerate the
blocks and edges each future diagram must contain — chip-block.svg.TODO
drawn from ADR-001..ADR-007 plus the PHY interface boundary in Section
13.3, board-block.svg.TODO drawn from ADR-008..ADR-014. Add a
docs/architecture/README.md that documents the scheme and the
replace-with-.svg ritual so the deliverable target stays explicit.

No design decisions are made here. Pure scaffolding so the eventual
diagram work has clear targets.