docs: fix spec drift in server.md/layout.md and a stale test comment - #304
Merged
Conversation
Deploying mouseterm with
|
| Latest commit: |
2e12be7
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://45884bb1.mouseterm.pages.dev |
| Branch Preview URL: | https://docs-spec-drift-nightly.mouseterm.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 contractThe 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 definespair/connect/connect2/challenge/decision/pair-result; the diagrams referencedpair-request,connect-request,challenge-request, andsession-established, none of which exist. A reader implementing against the wire would grep for these and find nothing.pair-request→pair(the frame carryingPairingRequest), in both the diagram and the following sentence.connect-request {hostId}→connect {hostId}(client→server) andchallenge-request→connect {clientId}(server→host, which is what prompts the host to issue thechallenge).session-established→decision(the real server→client frame — matching thedecisionalready shown on the host→server hop).docs/specs/layout.mdlath.neighborOf; the actual call islath.store.neighborOf(Wall.tsxline 375 —neighborOfis a store method, there is nolath.neighborOf).lib/src/lib/terminal-prompt-shape.test.tsReworded 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.