docs: README *Going further* — drop stale exports count + redundant docs/ bullet#41
Merged
Merged
Conversation
…ocs/ bullet 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.
There was a problem hiding this comment.
Pull request overview
Updates the root README’s Going further section to remove stale/incorrect references and keep the guidance accurate as the project’s generated artifacts and documentation structure evolve.
Changes:
- Replaces the
demos/bullet’s stale “six exports” claim with a count-free description and a concrete live example (demos/hello_led/docs/). - Removes the redundant/misleading
docs/bullet about “implementation specs” (since committeddocs/is user-facing, and implementation specs live in git-ignored working docs).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## 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/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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two stale references in the project root README's Going further section.
Finding 1 —
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. Replaced the hard-coded count with a category list and pointed atdemos/hello_led/docs/as the live example. Same "point at the auto-generated artefact, not the count" principle as PR #40.Finding 2 —
docs/bullet claimed "implementation specs for every major work package". Wrong: implementation specs live in.plans/(gitignored per CLAUDE.md's rule). The committeddocs/folder is user-facing documentation published to GitHub Pages. The section above already has a Documentation heading that links tohttps://raeq.github.io/wirebench/, so the bullet was redundant — dropped it.Diff:
+1 / -2onREADME.mdalone.Verification
grep -n "all six exports\\|implementation specs for every major" README.mdreturns no matches (exit 1).mkdocs build --strictpasses (no warnings).uv run pytest— 4829 passed; nothing tested the removed strings.