Skip to content

docs: fix spec drift in server.md/layout.md and a stale test comment - #304

Merged
nedtwigg merged 2 commits into
mainfrom
docs/spec-drift-nightly
Jul 27, 2026
Merged

docs: fix spec drift in server.md/layout.md and a stale test comment#304
nedtwigg merged 2 commits into
mainfrom
docs/spec-drift-nightly

Conversation

@dormouse-bot

Copy link
Copy Markdown
Collaborator

Nightly code-quality survey turned up several spots where reference docs had drifted from the code. All changes are documentation-only — no behavior changes.

docs/specs/server.md — sequence diagrams named frames that don't exist in the wire contract

The Pairing and Connect diagrams (and one prose sentence) used frame names that appear nowhere in server-lib-common/src/remote/wire.ts. The relay union defines pair / connect / connect2 / challenge / decision / pair-result; the diagrams referenced pair-request, connect-request, challenge-request, and session-established, none of which exist. A reader implementing against the wire would grep for these and find nothing.

  • pair-requestpair (the frame carrying PairingRequest), in both the diagram and the following sentence.
  • connect-request {hostId}connect {hostId} (client→server) and challenge-requestconnect {clientId} (server→host, which is what prompts the host to issue the challenge).
  • session-establisheddecision (the real server→client frame — matching the decision already shown on the host→server hop).

docs/specs/layout.md

  • Spatial navigation section referenced lath.neighborOf; the actual call is lath.store.neighborOf (Wall.tsx line 375 — neighborOf is a store method, there is no lath.neighborOf).
  • The Stage 4 workspaces note pointed at "corner case Custom-rendered app bar #10"; the Corner cases list is numbered 1–6. The "always one visible pane" behavior it cites is the auto-spawn refill — corner case UI improvements #5.

lib/src/lib/terminal-prompt-shape.test.ts

Reworded a garbled comment on the cmd.exe test — the previous text ("The trailing 'run' looks like…") referenced a "run" that doesn't appear in the test inputs. Now describes the actual case: at the drive root the tail :\> could be mistaken for the terminator, but the stable terminator across both paths is >.

pnpm lint:specs (spec-lint) passes. No code paths change, so there is nothing new to test; the test edit is a comment-only reword.

Surfaced by the nightly code-quality survey.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 27, 2026

Copy link
Copy Markdown

Deploying mouseterm with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2e12be7
Status: ✅  Deploy successful!
Preview URL: https://45884bb1.mouseterm.pages.dev
Branch Preview URL: https://docs-spec-drift-nightly.mouseterm.pages.dev

View logs

The corner-cases list in layout.md renumbered to 1-6; dor-browser.md still
pointed at #12. The focus-neutral surface-creation case is #6.
@nedtwigg
nedtwigg merged commit c27bafe into main Jul 27, 2026
7 checks passed
@nedtwigg
nedtwigg deleted the docs/spec-drift-nightly branch July 27, 2026 19:49
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