← Commit history

wiki-readme: hardware project pages must have a Components table with 64px part icons and a wiki link per row (pattern from john/buck-12v5v-molecule and adom/amfm-receiver-molecule)

John Lauer ·190c5c38de ·13d ago ·parent 05cbb72
1 file changed +33
skills/wiki-readme/SKILL.md+33
@@ -112,6 +112,9 @@ for the AI, the README is for the person deciding whether to install.  ## Mandatory sections (in this order) +**Hardware project, board and molecule pages also MUST have a `## Components` table with a part icon+and a wiki link on every row** (see "Hardware project pages: the component table" below).+ 1. **Title + one-line description**, the title is a **human, descriptive name,    NEVER the slug echo** (`Wiki Hero Image Skill`, not `adom-wiki-hero-image`).    Set it in `page.json` AND `package.json` (publish resets a missing manifest@@ -137,6 +140,36 @@ for the AI, the README is for the person deciding whether to install. 10. **Skills**, table of the main skill + sub-skills with a purpose column 11. **CLI reference**, command table (if there's a CLI) +## Hardware project pages: the component table with part icons (mandatory)++Every hardware **project, board or molecule** page README has a `## Components` table that lists+**every part** and links **each one to its wiki component page**. A row without a page is not+allowed: create the missing component page first (**wiki-component**), then link it. This is how+a reader, or an AI, walks from a project to every part it uses (John, 2026-10-11).++Each row's first cell carries a **64 px part icon** that links to the component page, then the MPN+(bold, linked) and the manufacturer. Copy this shape exactly (from `john/buck-12v5v-molecule` and+Noah's `adom/amfm-receiver-molecule`):++```markdown+| Part | Qty | Refs | Value | Role | Buy |+|---|---|---|---|---|---|+| <a href="https://wiki.adom.inc/adom/tps54202ddcr"><img src="docs/parts/tps54202ddcr.png?v=8124369c" width="64" alt="TPS54202DDCR"></a><br>**[TPS54202DDCR](https://wiki.adom.inc/adom/tps54202ddcr)**<br>Texas Instruments | 1 | U1 | TPS54202DDCR | sync buck 4.5-28 V 2 A | [Mouser 595-TPS54202DDCR](https://www.mouser.com/ProductDetail/595-TPS54202DDCR) |+```++- **The icon** is a small PNG of the real part (the component page's shaded chip thumbnail, or a+  render of its GLB), transparent background, stored on the PROJECT page as+  `docs/parts/<component-slug>.png`. Never a datasheet drawing or a generic placeholder.+- **`?v=<8 hex>`** is the start of the icon file's sha256, so a re-rendered icon is not served from+  cache. The path is relative to the page root, also inside sub-readmes (see **wiki-sub-readme**).+- `width="64"` is the only sizing that survives the sanitizer; `style=` is stripped.+- Group identical parts in one row (Qty + all Refs). Give the Buy column a real distributor link+  (Mouser first, then DigiKey/LCSC), or the Adom stock page for a Basic Part.+- Projects without reference designators (a symbol library, a cabinet layout) keep the icon cell+  and drop Qty/Refs: `| Part | Library symbol | Role | Buy |`.+- Verify on the rendered page in pup: every icon loads (`img.naturalWidth > 0`) and every link opens+  logged out when the page is public.+ ## Open-source pages need a "check it out, vibe-code it, send it back" section  If the page's source is public (open source), the README MUST teach the