Publish a Hardware Component to the Adom Wiki
Public Made by Adomby 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-
Publish a Hardware Component to the Adom Wiki
Private / Adom-only. The one-stop-shop for putting a hardware component — a discrete part
(resistor, MLCC, LED, inductor, connector, IC), a molecule (an assembled sub-board), or a full
board — on wiki.adom.inc and having it look right. It exists so a new session (or a new
teammate) doesn't re-derive the same things from scratch:
- what a component page is made of (page.json, README, characterization page, 3D model, symbol,
footprint, ct thumbnails, hero) and the clone → edit → snapshot → preview → approve → push loop
with
adom-wiki— as a runnable, documented module (scripts/publish_wiki_page.py), not just prose, - how to make a great hero image with Hero Component Studio — 16:10, overlay-safe framing, visual-mass centring, a part on a procedural PCB or a molecule on a shadow ground, all datasheet-backed (this is the part to get right — it's the first thing anyone sees),
- the animated 3D composite recipe (
<MPN>.glb/.insertion.glb), - the interactive 3D viewer (⚠️ under active development — Arav is reworking the viewer),
- the datasheet-accuracy audit (every value and chart traceable to a datasheet figure),
- and every wiki push/pull gotcha that cost time the first time (owner ≠
adom, the hero cache,page herowants a repo-relative path, blob.jswon't run as<script src>, README.html + srcdoc embedding, etc.).
How to use
Read SKILL.md — it's the whole playbook, organized as numbered sections you can jump to. Start at
The lifecycle at a glance, then §0 (hard rules) and §3 (the hero image). For the publish
mechanics specifically, scripts/publish_wiki_page.py is the programmatic reference. Other worked
builder scripts are in scripts/ (adapt per part).
Contributing
This is a living document. When you hit a new wiki issue or find a better recipe, add it to the
right section (usually §8 gotchas, §3 hero, or §4 composite), bump the version, and open a PR against
adom/adom-hardware-component-publish. Keep findings specific and cited.
# Publish a Hardware Component to the Adom Wiki
**Private / Adom-only.** The one-stop-shop for putting a **hardware component** — a discrete part
(resistor, MLCC, LED, inductor, connector, IC), a **molecule** (an assembled sub-board), or a full
**board** — on `wiki.adom.inc` and having it look right. It exists so a new session (or a new
teammate) doesn't re-derive the same things from scratch:
- what a component page is **made of** (page.json, README, characterization page, 3D model, symbol,
footprint, ct thumbnails, hero) and the **clone → edit → snapshot → preview → approve → push** loop
with `adom-wiki` — as a runnable, documented module (`scripts/publish_wiki_page.py`), not just prose,
- how to make a **great hero image** with **Hero Component Studio** — 16:10, overlay-safe framing,
visual-mass centring, a part on a procedural PCB or a molecule on a shadow ground, all
datasheet-backed (this is the part to get right — it's the first thing anyone sees),
- the **animated 3D composite** recipe (`<MPN>.glb` / `.insertion.glb`),
- the **interactive 3D viewer** (⚠️ under active development — Arav is reworking the viewer),
- the **datasheet-accuracy audit** (every value and chart traceable to a datasheet figure),
- and every **wiki push/pull gotcha** that cost time the first time (owner ≠ `adom`, the hero cache,
`page hero` wants a repo-relative path, blob `.js` won't run as `<script src>`, README.html +
srcdoc embedding, etc.).
## How to use
Read `SKILL.md` — it's the whole playbook, organized as numbered sections you can jump to. Start at
**The lifecycle at a glance**, then §0 (hard rules) and §3 (the hero image). For the **publish
mechanics specifically**, `scripts/publish_wiki_page.py` is the programmatic reference. Other worked
builder scripts are in `scripts/` (adapt per part).
## Contributing
This is a **living document**. When you hit a new wiki issue or find a better recipe, add it to the
right section (usually §8 gotchas, §3 hero, or §4 composite), bump the version, and open a PR against
`adom/adom-hardware-component-publish`. Keep findings specific and cited.