Skip to content

Fix superscripts lost in the vendored protocol docs - #2

Merged
m13m merged 1 commit into
masterfrom
docs/fix-superscripts
Oct 28, 2026
Merged

m13m merged 1 commit into
masterfrom
docs/fix-superscripts

Conversation

@m13m

@m13m m13m commented Oct 28, 2026

Copy link
Copy Markdown
Member

The HTML-to-markdown conversion dropped <sup> tags, so powers of two became their digits run together. page_protocol_basic_dt_integers.md read:

| 251 | 216 | 0xFC + 2-byte integer |
| 216 | 224 | 0xFD + 3-byte integer |
| 224 | 264 | 0xFE + 8-byte integer |

Those bounds are 2^16, 2^24 and 2^64. Taken literally the table produces an int<lenenc> codec that is wrong for every value above 250 — and that codec is the next thing phase 1 builds.

Same damage in two other pages, where 2^24-1 had become 224-1:

  • page_protocol_basic_packets.md — the packet splitting rule, three places
  • page_protocol_basic_compression_packet.md — compressed packet sizes

Found by re-running the conversion with <sup>/<sub> mapped to ^n/_n and diffing against the repo. These three pages are the only ones affected out of 78.

The HTML-to-markdown conversion dropped <sup> tags, so powers of two
became their digits run together. The length-encoded integer table read
"251 | 216", "216 | 224", "224 | 264" — those bounds are 2^16, 2^24 and
2^64. Taken literally the table produces a broken int<lenenc> codec,
which is the next thing phase 1 builds.

Same damage in the packet splitting rule and the compressed packet
page, where 2^24-1 had become 224-1.

Found by re-running the conversion with <sup> and <sub> mapped to ^n
and _n, then diffing; these three pages are the only ones affected out
of 78.
@m13m
m13m merged commit e6705a6 into master Oct 28, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant