← Commit history

add plugin-naming rule (titles lead with Adom USB)

John Lauer ·20a5b31aa5 ·4mo ago ·parent 2800bc7
1 file changed +18
skills/adom-usb/SKILL.md+18
@@ -69,6 +69,24 @@ To author one: copy `examples/adom-usb-sniffer-cdc/`, edit `plugin.json` (`matches` by class/vid/pid) + the `manifest`/`sniff` entrypoint, then publish with `adompkg`. Full guide: the wiki page → "Writing a packet-sniffer plugin". +### Naming your plugin (REQUIRED — make the Adom USB family obvious)++Every adom-usb plugin must advertise that it belongs to the **Adom USB**+ecosystem, because users see plugins out of context — a card in the wiki grid, a+search hit, a billboard cross-fading in the adom-screensaver — and need to know+at a glance it's part of Adom USB:++- **Slug**: `adom-usb-<kind>-<chip>` — e.g. `adom-usb-stub-rp2040`,+  `adom-usb-sniffer-cdc`. (Dash, not colon — colons are illegal in slugs.)+- **Page title** (the human-readable name shown on cards / search / the+  screensaver — this is the one that matters): MUST **lead with "Adom USB"** —+  e.g. `Adom USB — RP2040 persona pack`, `Adom USB — CDC serial sniffer`. A bare+  title like "RP2040 persona pack" hides the relationship; the slug only appears+  in the install command and **nobody reads slugs**.+- **Hero billboard**: carry the `ADOM-USB · FIRMWARE` / `ADOM-USB · SNIFFER`+  family chip (see the `adom-wiki-hero-image` skill).+- **Tag**: include `adom-usb-plugin` in `keywords`/`tags` so discovery finds it.+ ## Status  M1 ships the unified inventory + the mount overlay; each action emits the exact