← Commit history

Registry README: one project's tool becomes that page's readme.html

Colby Knox ·a60db0ed00 ·5h ago ·parent f8be708
1 file changed +2−5
README.md+2−5
@@ -27,12 +27,9 @@ not the URL readers fetch.  The registry is for **generic** widgets: one script that many pages reuse, each page passing its own data through attributes or a `src` file. A pinout, a table, a stock line and a video player all qualify: none of them knows which page it is on. -A tool built for **one project** does not belong here, however polished. Examples are an explorer for one board's circuit, a simulator of one design, or a calculator for one part: its data lives in the script, and only its own page can use it. Put it on that project's page as custom HTML instead:+A tool built for **one project** does not belong here, however polished. Examples are an explorer for one board's circuit, a simulator of one design, or a calculator for one part: its data lives in the script, and only its own page can use it. Make it that page's `readme.html` instead, with its JS and CSS inlined, so the tool is the page (it replaces README.md on the page). See the `wiki-readme-html` skill in adom/adom-wiki-skillpack. -- **A section next to the README** (keeps README.md): put an HTML file in the page repo with its JS and CSS inlined, then declare it in page.json, for example `"section_sources": {"explorer": "explorer/index.html"}`, and add `"explorer"` to `sections` where it should appear. It renders as its own sandboxed block in the main column.-- **The whole page body:** a `readme.html` (it replaces README.md on the page).--Both are covered by the `wiki-readme-html` skill in adom/adom-wiki-skillpack. A test for a proposed entry: could two unrelated pages each use it with their own data? If not, it is custom HTML, not a widget.+A test for a proposed entry: could two unrelated pages each use it with their own data? If not, it is a readme.html, not a widget.  ## Registering a widget