Scaffold docs/spec/ directory with Phase 5 deliverable stubs #30

New issue

Closed

opened 2026-05-24 15:23:22 -03:00 by navigator · 2 comments

navigator commented

2026-05-24 15:23:22 -03:00

Owner

Goal

Create empty stub files for the 10 Phase 5 documentation deliverables listed in PLAN.md Section 10, so future work can populate them incrementally without arguing about file paths. Each stub gets a title, a one-line description of intended content, and a Status: Stub marker.

Files to create:

docs/spec/pop-soc-v1.md
docs/spec/pop-accel-8-board-v1.md
docs/spec/fluidpop-isa.md
docs/spec/programming-model.md
docs/spec/poplink-phy-if.md (Section 13.4 deliverable #2)
docs/benchmarks/report-v1.md
docs/benchmarks/baseline-gemmini-rocket.md (Section 7)
docs/architecture/chip-block.svg placeholder (text file with TODO note)
docs/architecture/board-block.svg placeholder (text file with TODO note)
docs/funding/grant-proposal-pacid.md
docs/funding/tapeout-rfq.md
docs/funding/board-fab-rfq.md

Acceptance criteria

All 12 files listed above exist in the repo
Each markdown stub has H1 title, Status: Stub, Owner: TBD, and 2-3 line intent description
SVG placeholders are TODO text files (real SVGs come later when block diagrams are designed)
No fabricated content — stubs only
docs/spec/README.md (if not present) lists the spec files briefly

Plan refs

Section 10 (10 documentation deliverables); Section 7 (baseline benchmark report); Section 13.4 (PHY interface spec)

Notes

Pure scaffolding — no technical claims. Goal is to anchor file paths now so cross-references in ADRs and other docs don't break when these files get populated.

## Goal Create empty stub files for the 10 Phase 5 documentation deliverables listed in PLAN.md Section 10, so future work can populate them incrementally without arguing about file paths. Each stub gets a title, a one-line description of intended content, and a `Status: Stub` marker. Files to create: - `docs/spec/pop-soc-v1.md` - `docs/spec/pop-accel-8-board-v1.md` - `docs/spec/fluidpop-isa.md` - `docs/spec/programming-model.md` - `docs/spec/poplink-phy-if.md` (Section 13.4 deliverable #2) - `docs/benchmarks/report-v1.md` - `docs/benchmarks/baseline-gemmini-rocket.md` (Section 7) - `docs/architecture/chip-block.svg` placeholder (text file with TODO note) - `docs/architecture/board-block.svg` placeholder (text file with TODO note) - `docs/funding/grant-proposal-pacid.md` - `docs/funding/tapeout-rfq.md` - `docs/funding/board-fab-rfq.md` ## Acceptance criteria - [ ] All 12 files listed above exist in the repo - [ ] Each markdown stub has H1 title, `Status: Stub`, `Owner: TBD`, and 2-3 line intent description - [ ] SVG placeholders are TODO text files (real SVGs come later when block diagrams are designed) - [ ] No fabricated content — stubs only - [ ] `docs/spec/README.md` (if not present) lists the spec files briefly ## Plan refs Section 10 (10 documentation deliverables); Section 7 (baseline benchmark report); Section 13.4 (PHY interface spec) ## Notes Pure scaffolding — no technical claims. Goal is to anchor file paths now so cross-references in ADRs and other docs don't break when these files get populated.