Skip to content

docs(chat): the twelve chat pages teach through their examples; walkthroughs retired - #1038

Merged
blove merged 26 commits into
mainfrom
blove/docs-example-first-chat
Sep 6, 2026
Merged

docs(chat): the twelve chat pages teach through their examples; walkthroughs retired#1038
blove merged 26 commits into
mainfrom
blove/docs-example-first-chat

Conversation

@blove

@blove blove commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

PR 8 of the example-first docs program, and the last (plan: docs/superpowers/plans/2026-09-06-docs-example-first-products.md, PR 8 table; spec: docs/superpowers/specs/2026-09-05-docs-example-first-content-design.md).

Pages rewritten (12): chat/components/{chat-debug,chat-input,chat-interrupt-panel,chat-subagent-card,chat-tool-calls,chat-trace}, chat/concepts/message-model, chat/guides/{generative-ui,client-tools,theming,thread-routing}, chat/a2ui/overview. Each teaches through its running example with sequential <ExampleCode> blocks; every page went through an implementer, a factual review against libs/chat and libs/langgraph source, a fix pass, and a final cross-page read.

Walkthroughs deleted: the last twelve cockpit/**/docs/guide.md files (eleven under cockpit/chat/*, one under cockpit/langgraph/client-tools). With them gone, PENDING_PAGES and its case leave docs-example-code.spec.ts: every mapped page must now include its example. cockpit-retirement.spec.ts gains two cases: no cockpit/**/docs/guide.md exists, and no capability descriptor declares docsAssetPaths.

Example sources: comment-only region markers in the twelve capabilities' graphs and components (inline-template markers included; each example project builds). Three demo fixes where the running demo contradicted its own graph: the tool-calls sidebar listed search/calculator/weather while the graph binds the aviation tools; the subagents graph comment claimed a tools:<call_id> namespace (the uuid is a checkpoint id, unrelated to the tool-call id); activeThreadIdState is exported so the thread-routing guide's shell fences resolve.

Facts corrected on the pages (verified against source): <chat-trace> has no status icons, no label fallback, and no collapse-on-done rule (an untouched row falls back to defaultExpanded); neither <chat-trace> nor <chat-subagent-card> draws card chrome; chat theme tokens are injected on :root inside @layer tplane-chat, not on :host, and @threadplane/chat/chat.css does not exist; provideChat has no theme option; LangGraph always delivers Message.content as a string; classification is pending only for empty content or a leading - that may still become the A2UI sentinel; flush() on LangGraph is one threads.updateState call while the AG-UI adapter's is a no-op; bind_client_tools reads state["client_tools"] and ag-ui-langgraph needs a checkpointer while the LangGraph-served twins compile without one; the a2ui "data model does not update live" limitation is obsolete; A2UI progressive rendering is per component through $bindState, not through the dead A2uiSlotDirective.

Follow-ups, not in this PR: the messages demo double-submits (its (submitted) handler resubmits; the page names it as a defect); the threads demo renders two thread lists on desktop because <chat> mounts its own sidebar list when [threads] is bound; the chat-debug demo has no composer; unarchive is wired but unreachable in the threads demo; libs/chat/package.json exports a ./chat.css that ng-package.json cannot find; --tplane-chat-radius-input is declared but read by no chat component; A2uiSlotDirective is dead code; marked in libs/cockpit-shell/package.json is unused.

Verification: nx run-many -t test,lint green (website, cockpit-registry, cockpit-shell, scripts); both generators no drift; prod build renders all twelve pages with data-example-file counts equal to tag counts; nx e2e website 124 passed.

🤖 Generated with Claude Code

blove and others added 26 commits September 6, 2026 02:13
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…l; the layout shell; auto-dock

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
… name, theme tokens, eyebrow text

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…, one sentence after the config block

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…template branch, no card chrome from chat-trace

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
… aviation tool list in the demo sidebar

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…, a compilable stat_card fence

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…ng rule, the demo's double submit named

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…ive path, abridged fence labeled, root required

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…taches on every run

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
… built-in list, both root tokens

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…put row, a2ui presets

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…sAssetPaths returns

Every mapped page now includes its example, so the allow-list and its
case go. The retirement guard gains two cases: no cockpit/**/docs/guide.md
exists, and no capability descriptor declares docsAssetPaths.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…ifier rule, one sentence after each block

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@vercel

vercel Bot commented Sep 6, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated
threadplane Ignored Ignored Preview Sep 6, 2026 9:16am UTC

Request Review

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Automated approval: this PR received an intelligent (AI) code review. See the review comments on this PR.

@github-actions

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Claude finished @blove's task in 0s —— View job


I'll analyze this and get back to you.

@blove
blove merged commit b9c6b21 into main Sep 6, 2026
43 checks passed
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.

1 participant