TsukiNi22/ai-utils / skills/docs/better-protocol-doc
better-protocol-doc
VerifiedProtocol pages in a better-html-doc site
SKILL_DIR = directory of this file. The reading of the protocol and the structure are those of protocol-doc
(../protocol-doc/SKILL.md §2-§3: framing, payload types, one section per message type, code tables, summary of the frames,
handshake step by step, commands, storage; everything read from the code, unclear bytes asked or marked TBD): load it first.
This skill writes it as page(s) of a better-html-doc site (../better-html-doc), with the built-in protocol kind
(templates/protocol.css, loaded only on these pages).
1. Ask (AskUserQuestion, French) unless known
- Contenu (multiSelect) as
protocol-doc§1.2; Découpage :Une page (Recommandé)·Une page par partie(framing + messages / codes / handshake / commands, a big protocol). - The site and its languages come from its
site.toml(no site yet:better-html-docfirst; the pages go inRéférence).
2. Write the page(s)
src/pages/reference/<slug>.<lang>.md with kind = "protocol" - start from SKILL_DIR/templates/pages/reference/protocol.*.md.
- A message:
→ the name and its code, the byte layout (one cell per field: as wide as its name and type, the room left shared by its size;:::message HELLO 0x01 | field | type | size | description | |---|---|---|---| | type | u8 | 1 | `0x01` | | name | utf8 | var | the client name, 32 bytes at most | The rules of this message (when it is sent, what the other side answers, what makes it fail). :::var= a variable length; the cells wrap as lines of a table, only what is longer than the layout wraps in its cell), the table, the text after it. Columnsfield | type | size | description(French headerschamp | type | taille | descriptionwork too);#msg-<name>is its anchor (link it from the summary table:[HELLO](#msg-hello)). - Handshake / exchange: a numbered sequence in
:::html:<ol class="seq"><li><div><span class="dir">client → server</span> <br><code>HELLO</code> …</div></li></ol>(one exchange per item, the exact frames); a timing diagram, when it helps, as an inline SVG figure with computed arrows (html-style). - Code tables (errors, events, commands): Markdown tables, one per family, code in hex and decimal when the code uses both.
- Sizes and orders exactly as the parser reads them (endianness stated once in the framing section).
3. Build and check
The commands of better-html-doc, then python3 ../protocol-doc/scripts/check_protocol.py on the Markdown sources when it
applies (codes unique, every message of the summary documented), check_render.py of html-style on the built page (0 error) and
the screenshots at 1280 and 390 px (the layout of a message wraps, never scrolls the page sideways).
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 192k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 192k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 192k | Updated | Claude CodeCodex | Verified | Install |