← Commit history
README.md+1−1
@@ -144,7 +144,7 @@ The pack encodes these; they're worth stating here too: | **wiki-api** | The REST API + ``adom-wiki pkg`` CLI and the publish workflow. | | **wiki-publish-safely** | Operational pitfalls as hard rules + the verify-in-pup gate. | | **wiki-readme** | Make a great README: `README.md` vs `readme.html`, sections, embeds. |-| **wiki-readme-html** | Build a custom `readme.html`: sandbox limits, shadowing, self-containment, theming, verify loop. |+| **wiki-readme-html** | Build a custom `readme.html`: sandbox limits, how it shares the page with README.md (`readme_order`), self-containment, theming, verify loop. | | **wiki-readme-slideshow** | A narrated, fullscreen-capable slideshow inside a readme.html: per-slide TTS audio, key navigation, auto-advance. | | **wiki-sub-readme** | A README.md in a subfolder, rendered as its own sub-page, always introduced from the main README by a section card: header, a thumbnail the AI makes, three sentences. | | **wiki-visibility** | Public vs private source, public releases, the private readme. |
SKILL.md+1−1
@@ -102,7 +102,7 @@ important enough to state up front: | **wiki-api** | The REST API + ``adom-wiki pkg`` CLI, the two storage layers, the publish workflow. | | **wiki-publish-safely** | The operational pitfalls as hard rules; the verify-in-pup gate. | | **wiki-readme** | How to make a great README: `README.md` vs `readme.html`, sections, embeds (YouTube player via `::youtube{}`), images. |-| **wiki-readme-html** | Build a custom `readme.html`: sandbox limits, shadowing, self-containment, theming, verify loop; one project's interactive tool becomes its readme.html, never a registry widget. |+| **wiki-readme-html** | Build a custom `readme.html`: sandbox limits, how it shares the page with README.md (`readme_order`), self-containment, theming, verify loop; one project's interactive tool becomes its readme.html, never a registry widget. | | **wiki-sub-readme** | Make a sub-readme (`<folder>/README.md`) and ALWAYS its section card in the main README (header, AI-made thumbnail, three sentences). The repo-push / path / verify gotchas. | | **wiki-visibility** | Public vs private source, public releases, the private readme, open vs closed pages. | | **wiki-repo-styles** | The archetype taxonomy (Page / Skillpack / Family) and how to choose. |
package.json+1−1
@@ -1,7 +1,7 @@ {   "slug": "adom-wiki-skillpack",   "title": "Adom Wiki Skill Pack",-  "version": "0.8.48",+  "version": "0.8.49",   "type": "skill",   "hero": {     "path": "screenshots/hero.png"
page.json+1−1
@@ -201,7 +201,7 @@       "prompt": "Before I create this wiki page, check whether the thing already has a home."     }   ],-  "version": "0.8.48",+  "version": "0.8.49",   "description": "The Adom Wiki Skill Pack : one main skill plus the focused sub-skills that teach the AI to publish to wiki.adom.inc without breaking pages, name the wiki repo archetypes (Page, Skillpack, Family), and publish rich component pages (chips, molecules, boards). The wiki is six tools in one: git, package manager, releases, discussions, pull requests, and discovery. One package manager install drops the whole set onto your container. Includes reviewed Z-up component artwork, surface-selected MPN marking, reusable thumbnail caches and component-page widgets. Includes canonical video widgets, synchronized captions and chapters, and voiceover pacing checks.",   "dependencies": {     "adom/adom-wiki-hero-image": "^0.2.2",
skills/wiki-component/SKILL.md+4−3
@@ -49,8 +49,8 @@ they affect any user, with exact file/revision and evidence rather than session  Before publishing, search and reuse the exact component record, read its current remote files, preserve other contributors' content and manufacturer originals, and-check which README actually renders. `readme.html` can shadow `README.md`; update-the visible prose too. Verify the live identity, generic description and source links.+check which README actually renders: a page with both shows readme.html, then+README.md (page.json `readme_order` may change that); update the visible prose too. Verify the live identity, generic description and source links. Put board-specific notes in the existing project, not a new documentation repo.  ## Source means authority; tools belong in provenance@@ -309,7 +309,8 @@ provenance lightbox) you have two options:    page body in a sandboxed iframe (`sandbox="allow-scripts allow-downloads"`,    served unsanitized from `/readme/<owner>/<type>/<slug>?variant=public`) ,    inline CSS AND `<script>` both work, so the full tabbed/accordion/toolbar/-   lightbox layout is the real page now. It fully shadows README.md on the page.+   lightbox layout is the real page now. README.md still renders under it+   (page.json `readme_order` sets the order or shows one), so keep the notes there.    No `allow-same-origin`: self-contain everything (base64-inline fonts/images or    absolute `/blob/...` URLs; no wiki API calls from inside). See **wiki-readme**. 2. **Prototype it as a standalone page in the container** (for iterating before
skills/wiki-readme-html/SKILL.md+34−12
@@ -3,8 +3,9 @@ name: wiki-readme-html description: >-   How to build a custom HTML readme (readme.html) for an Adom Wiki page, the   fully designed, unsanitized alternative to README.md. Covers when to choose-  html over markdown, the shadowing rule (readme.html makes README.md invisible-  on the page), the sandboxed-iframe render pipeline and its exact limits+  html over markdown, how readme.html and README.md share the page (both+  render, HTML first; page.json readme_order sets the order or shows one),+  the sandboxed-iframe render pipeline and its exact limits   (scripts run, but no same-origin, no cookies, no wiki API, external links and   popups need care), self-containment (inline CSS/JS, base64 fonts/images,   /blob/ asset URLs), the six readme variant slots (bare/public/private ×@@ -13,7 +14,8 @@ description: >-   one renders blank, unstyled, clipped, or won't update. Trigger words: html   readme, readme.html, custom readme, custom html readme, designed readme,   readme with tabs, readme with accordion, readme iframe, readme sandbox,-  readme shadowed, README_SHADOWED, readme.html not rendering, readme not+  readme shadowed, README_SHADOWED, readme_order, readme order, html above+  markdown, markdown under the readme, readme.html not rendering, readme not   updating, fully custom page layout, custom page body, unsanitized readme,   interactive explorer, circuit explorer, simulator, calculator, applet for my   page, should this be a widget, register a widget, widgets.json, adom/widgets.@@ -58,8 +60,9 @@ make it the page's `readme.html`, so the tool IS the page: - Inline its JS and CSS in `readme.html`. The wiki serves a `.js` file from   `/render/` as a download (`application/octet-stream`, `nosniff`), so   `<script src="tool.js">` does not run.-- Fold the README.md content readers need into the HTML around the tool; the-  readme.html replaces README.md on the page (the shadowing rule below).+- Keep the written notes in README.md: it renders under the tool as its own+  block (see "readme.html and README.md together" below), so do not repeat+  them in the HTML. - Post `readme-height` so the frame fits (Sizing, below).  Do not tuck the tool into a separate block under a markdown README (page.json@@ -71,13 +74,31 @@ Put `readme.html` at the root of the publish tree and `adom-wiki pkg publish`. The page registers it (API: `readme_variants_json.bareHtml = "readme.html"`) and the Overview tab switches to HTML mode. -## The shadowing rule (the #1 gotcha)+## readme.html and README.md together -`readme.html` **fully shadows README.md on the page**. The publish linter warns:-`README_SHADOWED: readme.html is what renders on the page, so edits to README.md-will not be visible.` Keep a README.md anyway, the Files tab, `repo clone`-readers, and git tooling still use it, but every page-visible edit goes in the-HTML file. If "my readme edit isn't showing up," check which file you edited.+A page with both shows **both** on the Overview, each in its own labeled block:+`readme.html` first, `README.md` under it. They say different things: the HTML+is the designed or interactive part, the markdown the written notes (setup,+ordering, changelog, links). So README.md should say what the HTML does not,+never repeat it; the same words in both blocks reads as a broken page.++Set the order, or show only one, with `readme_order` in page.json:++| `readme_order` | Overview |+|---|---|+| absent, or `["html","md"]` | readme.html, then README.md (the default) |+| `["md","html"]` | README.md first, then readme.html |+| `["html"]` | readme.html only |+| `["md"]` | README.md only |++A page with only one of the two files shows that one, whatever the order says.+The push answers `README_ORDER_DECLARED` with what will render, or+`README_ORDER_INVALID` (a non-array, or values other than "html"/"md": the+default applies). With `["html"]`, a README.md edit does not show and the push+warns `README_SHADOWED`. README.md is still required at publish and is what+search and excerpts read, so keep it truthful either way. (Until 2026-10-20+the HTML always hid the markdown; older pages may still carry a README.md that+copies their HTML: trim it to the notes, or set `["html"]`.)  ## How it renders (and what the sandbox forbids) @@ -216,7 +237,8 @@ should read your content height, not 600.  ## Pitfalls recap -- Edited README.md, page unchanged → shadowing rule; edit readme.html.+- Edited README.md, page unchanged → page.json `readme_order` is `["html"]`; add "md" or edit readme.html.+- The same text twice on the page → README.md repeats readme.html; trim it to the notes the HTML lacks, or set `readme_order: ["html"]`. - Iframe stuck at ~600px / inner scrollbars -> you never posted readme-height; add the reporter above. - Iframe grows forever -> a vh-sized section is chasing the resize; pin it to fixed pixels. - Renders but unstyled/white → you assumed wiki CSS; the iframe gets nothing.
skills/wiki-readme-slideshow/SKILL.md+4−4
@@ -23,10 +23,10 @@ slideshow recipe on top.    - Back/Forward buttons + ArrowLeft/ArrowRight keydown, and dot navigation.    - A Fullscreen button calling `requestFullscreen()` WITH a `.catch(()=>{})` - see      the sandbox caveat below.-4. **Keep the markdown**: readme.html SHADOWS README.md on the page, so convert README.md-   to HTML (`python3 -c "import markdown..."` with `tables,fenced_code`) and append it-   below the show. Keep README.md in the repo for the Files tab and clone readers; every-   page-visible edit now goes through the readme.html rebuild.+4. **Keep the markdown as the notes**: README.md renders under the show as its own block+   (page.json `readme_order`, default `["html","md"]`), so leave the written notes there+   instead of converting them into the HTML. Set `["html"]` only if the show must stand+   alone. 5. **Height contract**: fixed-pixel stage (NEVER vh - the resize feedback loop), plus the    standard readme-height postMessage reporter from wiki-readme-html. 
skills/wiki-readme/SKILL.md+5−4
@@ -43,10 +43,11 @@ presentation modes:  Ship a `readme.html` in the publish tree and `pkg publish`. That's it. -- **It shadows README.md entirely.** The publish linter says so:-  `README_SHADOWED: readme.html is what renders on the page, so edits to-  README.md will not be visible.` Keep a README.md for the Files tab and git-  readers, but know the page ignores it.+- **Both render: readme.html first, README.md under it**, each in its own+  labeled block. Give README.md the written notes the HTML does not carry;+  never repeat the HTML. page.json `readme_order` changes it: `["md","html"]`+  puts the markdown first, `["html"]` or `["md"]` shows one (details in+  **wiki-readme-html**). - **How it renders:** the Overview tab embeds   `https://wiki.adom.inc/readme/<owner>/<type>/<slug>?variant=public` in an   iframe with `sandbox="allow-scripts allow-downloads"` (no `allow-same-origin`).