Uh oh!
There was an error while loading. Please reload this page.
docs: drop stale stream-substrate cross-references from comments - #742
Merged
Conversation
#736 removed streamVariants, LiveIndicator, and @Keyframes maka-pulse. Strip the prose that still named those symbols as current examples, peers, or retirement destinations, leaving the #736 "stays removed" guard and the accurate retirement narratives intact. Comments only — no code or CSS declarations changed. - packages/ui/src/primitives/chat.tsx: TextShimmer / toolVariants / previewVariants docs no longer cite LiveIndicator / maka-pulse / streamVariants as live peers. - apps/desktop/src/renderer/maka-tokens.css: maka-text-shimmer keyframe doc cites maka-tool-pulse (still in use) instead of the removed maka-pulse. - scripts/check-chat-marker-computed-style.mjs: header drops the stale LiveIndicator / maka-pulse "one element not diffed" sentence; the PR3b section's maka-tool-pulse running-dot note still stands. - design-system-governance-406-contract.test.ts: animation-name extraction example uses maka-tool-pulse (in use) instead of maka-pulse. - chat-stream-cascade-contract.test.ts: drop the dead "onto the shared maka-pulse" destination from the per-feature breath comment. Verified: chat-stream-cascade-contract + chat-tool-card-cascade-contract + design-system-governance-406 contract tests (15/15) and @maka/ui + @maka/desktop (main/renderer/storybook) typechecks all green.
…script header The header of scripts/check-chat-marker-computed-style.mjs still claimed the harness diffs the retired PR3 stream shell (panel / header / flags + pills / body / chunk, with data-live="true") and "proves the tool live-output stream shell migration (#332 / PR3)". Since #712 / #736 retired that shell, the fixture only constructs the quiet tool-output panel (panel / command / body, same production classes on both sides). Rewrite the two stale header passages to state the current coverage: the marker-migration baseline + the quiet-panel layout-invariant check, with the PR3 stream shell marked as retired history. Comments only; no code changed. The chat-stream-cascade-contract fixture-alignment assertions still pass (they match code identifiers, not header prose). Found by Codex review of #742.
Uh oh!
There was an error while loading. Please reload this page.
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 freeto 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.
Summary
Strips stale prose cross-references to the retired stream substrate (
streamVariants,LiveIndicator,@keyframes maka-pulse) from comments across 5 files, and corrects the computed-style script header that still claimed to diff the retired PR3 stream shell. #736 already removed the symbols, keyframe, and their registry/guard; this PR finishes the removal at the documentation layer — comments only, no code or CSS declarations changed.Why
Refs #736
After #736 squash-merged (b181741), comments still cited the removed symbols as if they existed ("like
LiveIndicator'smaka-pulse", "for the same reason asmarkerVariants/streamVariants", "pinned by ...@keyframes maka-pulseframes", "retired onto the sharedmaka-pulse"), and the computed-style script header still claimed to diff the retired stream shell's header/flags/pills/chunk/data-live. A reader following those references hits dead ends (or the #736 "stays removed" guard), so the prose is stale.Scope
Changed (comments only):
packages/ui/src/primitives/chat.tsx— TextShimmer / toolVariants / previewVariants doc comments no longer citeLiveIndicator/maka-pulse/streamVariantsas live peers.apps/desktop/src/renderer/maka-tokens.css—maka-text-shimmerkeyframe doc citesmaka-tool-pulse(still in use) instead of the removedmaka-pulse.scripts/check-chat-marker-computed-style.mjs— (1) header drops the staleLiveIndicator/maka-pulse"one element not diffed" sentence; (2) header's opening paragraph and "What this renders" passage corrected to state the current coverage (marker-migration baseline + quiet-panel layout-invariant check) instead of the retired stream shell's header/flags/pills/chunk/data-live. The PR3b section'smaka-tool-pulserunning-dot note still stands. (2) was found by Codex review.apps/desktop/src/main/__tests__/design-system-governance-406-contract.test.ts— animation-name extraction example usesmaka-tool-pulse(in use) instead ofmaka-pulse.apps/desktop/src/main/__tests__/chat-stream-cascade-contract.test.ts— drop the dead "onto the sharedmaka-pulse" destination from the per-feature breath comment.Not included (intentionally kept):
chat-stream-cascade-contract.test.ts(the describe-block retirement narrative and thestreamVariants/LiveIndicator/@keyframes maka-pulseabsence assertions) — these are the guard itself and accurate history.scripts/check-chat-marker-computed-style.mjs:113"after streamVariants retirement" — an accurate retirement marker, not a stale cross-reference.markerVariants(chat-view.tsx),toolVariants(tool-activity.tsx), and@keyframes maka-tool-pulse— still in production; only mentioned in comments, not deletion targets.Verification
chat-stream-cascade-contract+chat-tool-card-cascade-contract+design-system-governance-406contract tests: 15/15 pass (node --teston the compiled fixtures; covers the refactor(ui): remove retired streamVariants, LiveIndicator, and maka-pulse #736 "stays removed" guard, the governance motion guard, and the fixture-alignment assertions — which match code identifiers, not header prose).@maka/uitypecheck,@maka/desktoptypecheck (main + renderer + storybook): all green.User-facing impact
None — comments only.
Reviewer notes
The line between "stale cross-reference" (cleaned) and "accurate retirement narrative" (kept): a reference that presents a removed symbol as a current example/peer/destination was cleaned; a reference that explicitly marks a symbol as retired ("after X retirement", "X predate PR2", the guard's "stays removed" assertions) was kept. A Codex review flagged one P2 beyond the symbol-name grep — the script header still claimed to diff the retired PR3 stream shell's header/flags/pills/chunk/
data-live. The guiding principle was expanded accordingly: comments must truthfully state current behavior/coverage; history must be explicitly framed as past. See "Not included" for the kept set and commit ea83481 for the header correction.Checklist