From 109aef29e6004ec46cb367d10e5b61f287378cee Mon Sep 17 00:00:00 2001 From: subzero Date: Wed, 20 May 2026 22:37:31 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20README=20*Going=20further*=20=E2=80=94?= =?UTF-8?q?=20drop=20stale=20exports=20count=20+=20redundant=20docs/=20bul?= =?UTF-8?q?let?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Two stale references in the project root README's *Going further* section: - The `demos/` bullet said *"source + all six exports + rendered schematic"*. The shipped set is eleven export formats plus the breadboard SVG, the assembly guide, and three reports — twice what the count claimed. Replaced the hard-coded count with a category list (BOM / KiCad / SPICE / Mermaid / Graphviz / Yosys / SVG / breadboard SVG / assembly guide / reports) and pointed at `demos/hello_led/docs/` as the live example. Future format additions only need to add a category name, not bump a number. - The `docs/` bullet claimed *"implementation specs for every major work package"* — wrong. Implementation specs live in `.plans/`, which is gitignored per CLAUDE.md's rule. The committed `docs/` folder is user-facing documentation published to GitHub Pages, and the section above already has a *Documentation* heading that links to https://raeq.github.io/wirebench/. Dropped the redundant bullet rather than rewriting it. Verification: - `grep -n "all six exports\|implementation specs for every major" README.md` returns no matches. - `mkdocs build --strict` passes (no warnings). - `uv run pytest` — 4829 passed; nothing tested the removed strings. --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 660adcd..2f3a075 100644 --- a/README.md +++ b/README.md @@ -142,11 +142,10 @@ Full coverage of the framework, components, every export format with byte-determ ## Going further -- [`demos/`](demos/) — every demo is a complete study artifact (source + all six exports + rendered schematic). +- [`demos/`](demos/) — every demo is a complete study artifact: source plus the full set of generated exports (BOM, KiCad netlist + schematic, SPICE deck, Mermaid / Graphviz / Yosys / SVG renders, breadboard SVG, assembly guide, net / domain / interface reports). [`hello_led/docs/`](demos/hello_led/docs/) is a live example. - [`docs/learning-path.md`](docs/learning-path.md) — suggested order for working through the demos. - [`docs/design-principles.md`](docs/design-principles.md) — why the framework prevents what it prevents. - [`docs/component-library-data.md`](docs/component-library-data.md) — hand-curated catalogue with datasheet links, pin maps, and footprints; [`docs/parts.md`](docs/parts.md) — auto-generated index of all 150 modelled components, searchable on the doc site. -- [`docs/`](docs/) — implementation specs for every major work package. - [`CLAUDE.md`](CLAUDE.md) — design philosophy in full, for contributors. ## Licensing