Skip to content

Condense public documentation, tutorial, and WebGL specs - #906

Merged
nedtwigg merged 5 commits into
spec-cleanup-hostedfrom
spec-cleanup-public-docs
Oct 2, 2026
Merged

nedtwigg merged 5 commits into
spec-cleanup-hostedfrom
spec-cleanup-public-docs

Conversation

@nedtwigg

@nedtwigg nedtwigg commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

Condense the public-documentation, tutorial, and WebGL text specs around canonical parser, generator, component, and fork implementations. Keep authored behavior and concrete cross-file invariants, including selectable code, unique anchors, tutorial transition ordering, and SDF padding. Move supporting evidence to the paired rationale.

Correct fork peer-version grammar and upstream-update wording. Identify current origin-prefix and query-fragment validation limits without claiming an unpublished generator fix. Four documentation files and lower word budgets change.

Validation: all 277 website tests across 25 files, website types and generation; 15 xterm tests; spec/public-doc/xterm lints and spec mutations. Stacked on #904.

Trimmed in review. Restored the webgl-text.md SDF bullets: 16 floats per cell, alias pixels, the shared SDF_CUTOFF, and the warning about upstream merges touching vertex code. They are concrete constants, not something to replace with pointers into another repo.

🤖 Generated with Claude Code

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

Deploying mouseterm with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6e1817e
Status: ✅  Deploy successful!
Preview URL: https://54be602b.mouseterm.pages.dev
Branch Preview URL: https://spec-cleanup-public-docs.mouseterm.pages.dev

View logs

@dormouse-bot dormouse-bot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two inline points in docs/specs/website-docs.md: a guide rule that is now stated twice, and a buildCli sentence that lost its consequence when it was condensed.

Comment thread docs/specs/website-docs.md Outdated
Comment thread docs/specs/website-docs.md Outdated
nedtwigg and others added 2 commits October 2, 2026 06:37
The condensed webgl-text.md replaced the Rasterization, Color-free atlas,
and Shader/renderer bullets with pointers into the xterm.js fork repo. That
dropped facts a careful editor needs and cannot see from this repo: the
16-floats-per-cell instance layout (upstream 11), that glyph aliases do not
count toward used pixels, the encode/decode SDF_CUTOFF import, and the
warning that upstream merges touching GlyphRenderer vertex code need care.

Restore those three bullets verbatim from the base, keeping this PR's other
corrections in the file (the `^<workspace-core-pin>` addon peer and the
"fork-base update" wording), and ratchet the budget for the restored text.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@nedtwigg
nedtwigg merged commit 5ce9132 into main Oct 2, 2026
22 checks passed

This branch is waiting to be deployed

1 waiting deployment
hosted-preview — 6e1817e8 Waiting Oct 2, 2026 by nedtwigg via cleanup #765
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.

2 participants