Fluid/fluidpop-v1

Fork 0

Create docs/architecture/ README + SVG placeholder stubs #122

New issue

Open

opened 2026-05-27 15:05:07 -03:00 by navigator · 3 comments

navigator commented

2026-05-27 15:05:07 -03:00

Owner

Goal

Create the docs/architecture/ directory with placeholder stubs for the two block diagrams listed as deliverables #6 and #7 in PLAN.md Section 10 (chip-block.svg and board-block.svg). Since these are SVG deliverables that require actual block-diagram design work, this issue creates plain-text TODO placeholder files plus a README describing the intended content of each diagram so future design work has clear targets.

Files to create:

docs/architecture/README.md — describes the directory, lists each diagram, links back to relevant PLAN.md sections
docs/architecture/chip-block.svg.TODO — text file describing required content for chip-level block diagram (4 Gemminis, 4x4 xbar, 2 Rocket cores, 256 KiB scratchpad, DDR5 controller, PopLink fabric ports, optional PCIe host bridge for master variant)
docs/architecture/board-block.svg.TODO — text file describing required content for board-level block diagram (8 SoCs in 2x4 torus, designated master, 8 DDR5 DIMMs, cold plate envelope, BMC, PCIe Gen4 x16 host link, OAM 2.0 form factor)

Acceptance criteria

docs/architecture/README.md exists and lists both diagrams with intended scope
docs/architecture/chip-block.svg.TODO enumerates required blocks per Section 8.1 chip-level ADRs (ADR-001..007) and PHY interface per Section 13.3
docs/architecture/board-block.svg.TODO enumerates required blocks per Section 8.1 board-level ADRs (ADR-008..014)
No actual SVG content created — only TODO text placeholders (real SVG design is separate downstream work)
README explicitly notes that the SVGs replace these .TODO files when ready

Plan refs

Section 10 (deliverables #6 and #7); Section 8.1 (chip-level and board-level ADRs informing diagram content); Section 13.3 (PHY interface to include in chip diagram)

Notes

The .TODO suffix avoids creating empty/invalid SVG files. When a contributor produces a real diagram, they replace the .TODO with the .svg. Pure scaffolding — no design decisions are made here.

## Goal Create the `docs/architecture/` directory with placeholder stubs for the two block diagrams listed as deliverables #6 and #7 in PLAN.md Section 10 (`chip-block.svg` and `board-block.svg`). Since these are SVG deliverables that require actual block-diagram design work, this issue creates plain-text TODO placeholder files plus a README describing the intended content of each diagram so future design work has clear targets. Files to create: - `docs/architecture/README.md` — describes the directory, lists each diagram, links back to relevant PLAN.md sections - `docs/architecture/chip-block.svg.TODO` — text file describing required content for chip-level block diagram (4 Gemminis, 4x4 xbar, 2 Rocket cores, 256 KiB scratchpad, DDR5 controller, PopLink fabric ports, optional PCIe host bridge for master variant) - `docs/architecture/board-block.svg.TODO` — text file describing required content for board-level block diagram (8 SoCs in 2x4 torus, designated master, 8 DDR5 DIMMs, cold plate envelope, BMC, PCIe Gen4 x16 host link, OAM 2.0 form factor) ## Acceptance criteria - [ ] `docs/architecture/README.md` exists and lists both diagrams with intended scope - [ ] `docs/architecture/chip-block.svg.TODO` enumerates required blocks per Section 8.1 chip-level ADRs (ADR-001..007) and PHY interface per Section 13.3 - [ ] `docs/architecture/board-block.svg.TODO` enumerates required blocks per Section 8.1 board-level ADRs (ADR-008..014) - [ ] No actual SVG content created — only TODO text placeholders (real SVG design is separate downstream work) - [ ] README explicitly notes that the SVGs replace these .TODO files when ready ## Plan refs Section 10 (deliverables #6 and #7); Section 8.1 (chip-level and board-level ADRs informing diagram content); Section 13.3 (PHY interface to include in chip diagram) ## Notes The `.TODO` suffix avoids creating empty/invalid SVG files. When a contributor produces a real diagram, they replace the `.TODO` with the `.svg`. Pure scaffolding — no design decisions are made here.

navigator added the

docs

agent:in-progress

labels

2026-05-27 15:05:07 -03:00

navigator commented

2026-05-27 15:07:43 -03:00

Author

Owner

No description provided.

navigator commented

2026-05-27 15:08:37 -03:00

Author

Owner

All three deliverables for this issue already exist on `main`:

docs/architecture/README.md
docs/architecture/chip-block.svg.TODO
docs/architecture/board-block.svg.TODO

They were landed by PR #67 (merged commit 865f8e6, docs(architecture): README + .TODO stubs for chip-block / board-block diagrams).

The worktree based on origin/main is clean — there is nothing to add. Please close as duplicate of #67 (or as already-done).

All three deliverables for this issue already exist on `main`: - `docs/architecture/README.md` - `docs/architecture/chip-block.svg.TODO` - `docs/architecture/board-block.svg.TODO` They were landed by PR #67 (merged commit `865f8e6`, *docs(architecture): README + .TODO stubs for chip-block / board-block diagrams*). The worktree based on `origin/main` is clean — there is nothing to add. Please close as duplicate of #67 (or as already-done).

navigator added

agent:blocked-resolver

and removed

agent:in-progress

labels

2026-05-27 15:13:15 -03:00

navigator commented

2026-05-27 15:13:16 -03:00

Author

Owner

No description provided.

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

Fluid/fluidpop-v1#122

No description provided.

Rows
Columns