docs(vocab): post/surface prose + CLI help sweep (A6–A8)#149
Merged
Conversation
Adopt the workspace ▸ session ▸ post ▸ surface vocabulary in human-readable text only — guide prose, CLI help/messages, and code comments/strings. No code identifiers, routes, MCP tool names, SSE event types, JSON keys, or control flow changed; behavior is unchanged. - guide: DESIGN_GUIDE.md, AGENT_HOWTO.md, AGENTS.md — artifact "surface"→"post", block "part"→"surface", tenant "board"→"workspace". Protected terms kept: the `status board` kit name and the board.html example. AGENT_SETUP.md left as-is (its "surface" hits are the English/product sense). - CLI (bin/sideshow.js): help text, usage, and console messages reworded. The `comment` command gains `--post` with `--surface`/`--snippet` kept as aliases; the request still sends wire body key `surface`. Every HTTP endpoint unchanged. - server/viewer comments + user-facing error strings reworded (e.g. "a surface needs at least one part"→"a post needs at least one surface"). - test/cli.test.ts: watch-output assertions updated to the new `(post <id>)` label; the streaming child is now killed in `finally` so a failed assertion can't block server.close() on an open SSE connection. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
What
A6+A7+A8 of the
workspace ▸ session ▸ post ▸ surfacerename: the prose, CLI-help, and comment sweep. Adopts the new vocabulary in everything human-readable, with zero behavior change.guide/DESIGN_GUIDE.md,guide/AGENT_HOWTO.md,AGENTS.md— artifact "surface"→"post", block "part"→"surface", tenant "board"→"workspace".guide/AGENT_SETUP.mdleft as-is (its "surface" hits are the English/product sense).bin/sideshow.js): help text, usage, and console messages reworded.sideshow commentgains a--postflag with--surface/--snippetkept as working aliases; the request still sends wire body keysurface. Every HTTP endpoint and subcommand is unchanged.Behavior unchanged — protected/wire strings kept byte-identical
No code identifier, route, MCP tool name, SSE event type, JSON key, query key, or control flow changed. Preserved verbatim:
/api/surfaces,/api/snippets, thepartsbody key,?part=/?surface=,surface-created/-updated/-deleted, the deprecated MCP tool aliases, thestatus boardkit name, theboard.htmlexample, and--surfaceCSS vars.Test fix
The CLI
watchoutput label changed(surface <id>)→(post <id>)(a comment attaches to a post).test/cli.test.tsasserted the old label; updated to(post <id>). Also moved the streaming child'skill()intofinallyso a failed assertion can't leave an open SSE connection blockingserver.close()(this previously turned the failure into a hang).Review
Writer + fresh-context reviewer. Reviewer verified: every
bin/sideshow.jschange is help/comment/message-only with all endpoints unchanged;status board/board.htmlpreserved; no wire string touched; vocab mapping correct (no inversions). Five leftover tenant-boardcomments it flagged are fixed in this PR.Gates
typecheck✓ ·test261/261 ✓ ·test:e2e68/68 ✓ ·lint✓ ·format:check✓ ·build✓ · changesetsideshowpatch🤖 Generated with Claude Code