by adom
Create a wiki component page the RIGHT way. Pages are keyed manufacturer-mpn and scoped to ONE DATASHEET, so a datasheet covering six voltages and three packages is ONE page covering all of them, never six pages. Two manufacturers publishing the same MPN are two pages, because their limits genuinely differ. Renders through a hand-built readme.html on the Adom theme tokens with a fixed ten-section shape (identity, at a glance, specifications, symbol+footprint viewers, pin map, variants, assets, i
← Commit history
Merge PR #102: Carry the generic-description and Z-up/Y-up GLB rules inline, instead of only in wiki-component
1 file changed
+3
SKILL.md+3@@ -151,6 +151,8 @@ python3 scripts/inject_layers.py /tmp/raw.html part.kicad_mod fp-<pkg>.html # python3 scripts/build_switcher.py <dir> <vendor> viewer-footprints.html # multi-package ``` +> **`step2glb` writes glTF, which is Y-up. Adom is Z-up, with the seating plane on XY.** Check the GLB in the target viewer before posing a hero, because the viewer may already apply an axis conversion of its own: a blanket 90 degree rotation then lands twice, and a part that reads as wrong is usually standing on edge rather than mis-scaled. Inspect the GLB node transforms and the viewer's own import convention, and never correct an orientation problem by moving only the camera. Confirm pin 1 and the seat plane with `adom-chipfit check --footprint part.kicad_mod --glb part.glb`; a successful conversion and a sane bounding box establish neither. (Full rule: **wiki-component**, "Component GLB, Z-up and hero workflow".)+ > **`adom-footprint` 1.0.20 ships the fab, silk and courtyard layer groups EMPTY** (both `embed` and `render`), so the component outline is invisible and you get floating pads with no body. `scripts/inject_layers.py` parses the `.kicad_mod` graphics and fills them, and widens the viewBox (which is computed from copper only, so courtyards clip). Tracked as adom/adom-footprint#2. Drop the workaround once that lands. **Do NOT ship generated Fusion `.lbr` or Altium `.IntLib`/`.SchLib`/`.PcbLib`.** They are generated rather than hand-verified and the Altium symbol encoder has produced wrong geometry before. Ship the placeholder from §6 instead. Generated-but-unchecked CAD on a public page is worse than a gap, because a reader assumes it was verified.@@ -190,6 +192,7 @@ Add sections when the part earns them (thermal-design tables, application notes, ``` `prose-lint` matches the literal `—` and `–` characters and **not their HTML entities**, so a `readme.html` written with `—` passes clean while the rendered page is full of em-dashes. Grep for the entities yourself until adom/prose-lint#1 lands. Substitutions that read well: a dash introducing an elaboration becomes a colon, or a period plus a capital when what follows is an independent clause; a bare dash in a table cell becomes `n/a`; a numeric range `1.5 – 2.5` becomes `1.5 to 2.5`.+- **The page is a catalog record, not your board's notes.** The title, brief and the identity-header summary must read like the datasheet's own description and make sense to an engineer who has never seen the project that first needed the part. Lead with manufacturer, exact MPN, function and package. A particular board's reference designators, chosen component values, rail names, selection rationale and experiment progress belong on that board's umbrella or molecule page, not here. A short Related link to the consuming project is useful in section 8, but it must not turn the summary into that project's progress report. Label application examples as examples, not as universal requirements. (Full rule: **wiki-component**, "Write for every user of the component".) - **Every number is attributable.** If it is not in the datasheet, either cite where it came from in Provenance or leave it out. - Keep the `postMessage` height-reporting script at the bottom of the template. The wiki sizes the readme iframe from it.