by adom
The one-stop-shop for publishing a hardware component (or molecule/board) to the Adom Wiki. The whole lifecycle: page anatomy, the clone→edit→preview→push loop and its hard rules, making a great hero image (Hero Component Studio — 16:10, overlay-safe, datasheet-backed), the animated 3D composite, the interactive 3D viewer, ct thumbnails, the datasheet-accuracy audit, and every wiki push/pull gotcha we've hit. Now includes the worked Path B (board) pipeline: STEP-to-GLB, refdes tagging, layer de-
← Commit history
repoint renamed deps: adom-2dboard / adom-schematic / adom-project-manager
2 files changed
+20−20
SKILL.md+15−15@@ -159,8 +159,8 @@ end as the one seamless full-page README (§5.0).** | Need | App | Command | |---|---|---|- | Schematic (`.kicad_sch`, every sheet) | [`adom/adom-schematic-viewer`](https://wiki.adom.inc/adom/adom-schematic-viewer) | `adom-schematic-viewer embed --file <sheet>.kicad_sch --out sch-<n>.html` |- | PCB layout (`.kicad_pcb`) | [`adom/adom-layout-viewer`](https://wiki.adom.inc/adom/adom-layout-viewer) | `adom-layout-viewer embed --file <board>.kicad_pcb --out layout.html` |+ | Schematic (`.kicad_sch`, every sheet) | [`adom/adom-schematic`](https://wiki.adom.inc/adom/adom-schematic) | `adom-schematic embed --file <sheet>.kicad_sch --out sch-<n>.html` |+ | PCB layout (`.kicad_pcb`) | [`adom/adom-2dboard`](https://wiki.adom.inc/adom/adom-2dboard) | `adom-2dboard embed --file <board>.kicad_pcb --out layout.html` | - `embed` emits **one self-contained interactive HTML file** (SVG + metadata + viewer JS inlined, no external assets) — which is exactly what the wiki's sandboxed readme frame can host, and it@@ -173,7 +173,7 @@ end as the one seamless full-page README (§5.0).** - **Pass `--sheet-dir` or you silently publish a one-sheet schematic.** `embed --file root.kicad_sch` alone reports `0 child sheets bundled` **even when the sub-sheets sit right beside the root** — hierarchical children are only pre-rendered when you point at their directory:- `adom-schematic-viewer embed --file <root>.kicad_sch --sheet-dir <dir> --out sch.html`+ `adom-schematic embed --file <root>.kicad_sch --sheet-dir <dir> --out sch.html` → `3 child sheets bundled`, and the embed's SHEET selector switches between them instantly with no reload. One embed covers the whole hierarchy, so you do NOT need one iframe per sheet. (On `adom/feeder-reader` the root holds 25 of 138 parts — without the flag the MCU, Power and@@ -185,7 +185,7 @@ end as the one seamless full-page README (§5.0).** had 18 root symbols against the published 45). - The layout embed needs only the `.kicad_pcb`; side panels auto-hide below 620 px, so give each frame real height.- - Install: `adom-wiki pkg install adom/adom-schematic-viewer adom/adom-layout-viewer`. Both need+ - Install: `adom-wiki pkg install adom/adom-schematic adom/adom-2dboard`. Both need `KICAD_SERVICE_API` (service-kicad) for the authentic render; the layout viewer self-renders if it can't reach it (and looks less like KiCad, so prefer having it up). 4. **`page.json` mapping for a board** (the schema is component-shaped; use this convention):@@ -685,11 +685,11 @@ one shadows it and every import silently gets an unanchored model. (This is what boards.) Verify by sha256: the GLB served at `model_3d_path` must be byte-identical to your gated conversion output. -#### Versioning + the `render/` archive — `adom-nucleus` OWNS this+#### Versioning + the `render/` archive — `adom-project-manager` OWNS this ```bash-adom-wiki pkg install adom/adom-nucleus # once per container (APM was renamed to adom-nucleus)-adom-nucleus --render-board <slug> # AFTER pkg publish + repo push — ordering is load-bearing+adom-wiki pkg install adom/adom-project-manager # once per container+adom-project-manager --render-board <slug> # AFTER pkg publish + repo push — ordering is load-bearing ``` - **Never hand-write `render/<version>/` or edit `render/manifest.json`.** `--render-board` fully@@ -723,7 +723,7 @@ adom-nucleus --render-board <slug> # AFTER pkg publish + repo push — or #### Component dependencies + auto-created part pages (NOT optional) A board whose `dependencies` is `{}` while it has electrical parts is a **failed publish** — it looks-fine but shows up in APM/adom-nucleus with no BOM panel. The graph is+fine but shows up in the Project Manager with no BOM panel. The graph is **`board → <board-slug>-library → components`**: 1. Parse the BOM (CSV beside the sources, else the `.kicad_sch`); **electrical rows only** — skip@@ -736,7 +736,7 @@ fine but shows up in APM/adom-nucleus with no BOM panel. The graph is refs. The board's `dependencies` is then exactly `{ "<owner>/<board-slug>-library": "*" }`. > **Why a separate library page at all?** It is required by `molecule-publish` Stage 2.5 (wiki > issue #15), not a convention we invented: the board deliberately does **not** carry the raw- > parts list, because adom-nucleus/APM is built around a `board → library → components` graph and+ > parts list, because adom-project-manager (APM) is built around a `board → library → components` graph and > one-hop dependency expansion. Putting 100+ part refs directly on the board flattens that graph > and the BOM panel stops working. Reference shapes: > `barrett-land/usb3-to-ethernet-dataonly-molecule-library`, `adom/uv-current-monitor-board-library`.@@ -846,7 +846,7 @@ driving the debug handle, not by waiting. > **Path A only.** A board/molecule has no schematic symbol and no footprint, so it gets **no > `ct/` symbol+footprint pair and no "Symbol & Footprint" section** — its equivalents are the-> `adom-schematic-viewer` + `adom-layout-viewer` embeds (Path B item 3).+> `adom-schematic` + `adom-2dboard` embeds (Path B item 3). ```bash # stage the part's STEP into the chip-fetcher library, then:@@ -1125,7 +1125,7 @@ Two things that will still bite you: `window.__wikiCap` earlier sees `undefined` (silently → no cap → 404 → "bundle failed to load"). Defer to `DOMContentLoaded` and poll briefly for the token before substituting. Two ways to sidestep the whole class: the **native** viewers (trusted, unsandboxed, already-authenticated), and **self-contained** embeds like `adom-schematic-viewer/adom-layout-viewer embed`,+authenticated), and **self-contained** embeds like `adom-schematic/adom-2dboard embed`, which fetch nothing. Note the readme itself is capped at **4 MB rendered** (`README_TOO_LARGE`), so inlining a multi-MB 3D bundle+model into README.html is not a viable workaround — that is what the cap mechanism is for.@@ -1202,9 +1202,9 @@ reflects the corrected pads. - **`molecule-publish`** (`adom/molecule-publish`) — the convert/package/publish middle: OCCT conversion + stats gates, component dependencies + auto-created part pages, and the publish completion checklist.-- **`adom-nucleus`** (formerly `adom-project-manager`) — **owns `render/` and the per-version+- **`adom-project-manager`** — **owns `render/` and the per-version archive** via `--render-board <slug>`; also the consumer of the dependency graph (BOM panel).-- **`adom-schematic-viewer`** / **`adom-layout-viewer`** — the interactive schematic and PCB embeds a+- **`adom-schematic`** / **`adom-2dboard`** — the interactive schematic and PCB embeds a board page uses **instead of** hand-rolled board maps or static sheet images (Path B item 3). - **`adom-step2glb`** — the OCCT conversion CLI/service that produces the one blessed GLB. @@ -1240,14 +1240,14 @@ Be honest about maturity so nobody assumes a section is turnkey when it isn't. - The **preview harness** (`scripts/preview_readme/` — real sandbox flags + the readme-height handler + CORS). - ⚠️ **`scripts/kicad_board_map.py` / `kicad_board_geom.py` are SUPERSEDED** — board maps were this- skill's own invention; a board page now embeds `adom-schematic-viewer` + `adom-layout-viewer`+ skill's own invention; a board page now embeds `adom-schematic` + `adom-2dboard` (Path B item 3). The scripts remain only for the section-colouring data the viewer config uses. **Still to build for Path B:** - **A `board-viewer-cli`** — the config shape exists and is authorable as JSON, but the "never hand-edit, go through a CLI" rule has no CLI yet for board viewer configs. - **Full molecule-pipeline conformance on a real page** — §5b-2 documents the invariants,- `adom-nucleus --render-board` versioning, and the library/component dependency graph from+ `adom-project-manager --render-board` versioning, and the library/component dependency graph from `molecule-publish`; exercising all of it end-to-end on `adom/feeder-reader` is in progress. - **Board visual functions** (LEDs blinking, indicators). The LED-lighting method is referenced (Caleb's playbook) but not built into our tooling; the data-HUD path (§Path B) is the proven
package.json+5−5@@ -2,8 +2,8 @@ "slug": "adom-hardware-component-publish", "title": "Publish a Hardware Component to the Adom Wiki", "type": "skill",- "version": "0.10.0",- "description": "The one-stop-shop for publishing a hardware component (or molecule/board) to the Adom Wiki. The whole lifecycle: page anatomy, the clone\u2192edit\u2192preview\u2192push loop and its hard rules, making a great hero image (Hero Component Studio \u2014 16:10, overlay-safe, datasheet-backed), the animated 3D composite, the interactive 3D viewer, ct thumbnails, the datasheet-accuracy audit, and every wiki push/pull gotcha we've hit. Now includes the worked Path B (board) pipeline: STEP-to-GLB, refdes tagging, layer de-fighting, two-mode board viewer (Assembly merged with explanation + free-camera Static) template, board maps, preview harness. A living, refinable skill \u2014 add gotchas via PR. Private, Adom-only.",+ "version": "0.10.1",+ "description": "The one-stop-shop for publishing a hardware component (or molecule/board) to the Adom Wiki. The whole lifecycle: page anatomy, the clone→edit→preview→push loop and its hard rules, making a great hero image (Hero Component Studio — 16:10, overlay-safe, datasheet-backed), the animated 3D composite, the interactive 3D viewer, ct thumbnails, the datasheet-accuracy audit, and every wiki push/pull gotcha we've hit. Now includes the worked Path B (board) pipeline: STEP-to-GLB, refdes tagging, layer de-fighting, two-mode board viewer (Assembly merged with explanation + free-camera Static) template, board maps, preview harness. A living, refinable skill — add gotchas via PR. Private, Adom-only.", "tags": [ "skill", "wiki",@@ -20,8 +20,8 @@ ], "dependencies": { "adom/molecule-pipeline": "*",- "adom/adom-schematic-viewer": "*",- "adom/adom-layout-viewer": "*"+ "adom/adom-schematic": "*",+ "adom/adom-2dboard": "*" }, "scripts": { "install": "./install.sh",@@ -65,5 +65,5 @@ "footprint viewer", "adom-hardware-component-publish" ],- "discovery_pitch": "The one-stop-shop for putting a hardware component on the Adom Wiki and having it look right \u2014 the push loop, a great hero image, the 3D composite/viewer, and every gotcha, in one place."+ "discovery_pitch": "The one-stop-shop for putting a hardware component on the Adom Wiki and having it look right — the push loop, a great hero image, the 3D composite/viewer, and every gotcha, in one place." }