docs(render): technical review — fix accuracy across all 18 render pages#590
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
5 tasks
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.
Summary
A full technical-accuracy review of all 18 render documentation pages, cross-referenced against library source (
libs/render,libs/chat/src/lib/a2ui,libs/a2ui). Five parallel read-only auditors produced a severity-ranked findings report; all 17 findings are fixed, each gated by a source-cited accuracy review.Findings report:
docs/superpowers/specs/2026-06-06-render-docs-review-findings.md.Fixes by section
ebe716c3):surface-store.mdxused obsolete A2UI envelope names (createSurface/updateComponents/updateDataModel) — corrected to the real protocol (surfaceUpdate/dataModelUpdate/beginRendering/deleteSurface, perlibs/a2ui).catalog.mdxdocumented wrong component props — fixed Button (childKeys/primary), TextField (text), Slider (minValue/maxValue), DateTimeInput (enableDate/enableTime), CheckBox (value), removed nonexistent Cardtitle, and corrected a flat→keyed-union Text example.b04aa7d7): documented the previously-missinggetFallback()method + fallback-rendering behavior; clarifiedChatComponentis from@threadplane/chat.29592752): documentedgetFallback()andRenderContext.emitEvent; fixed thesignalStateStoresignature.bc68c2a3): completed theA2uiSurface/A2uiActionMessagetype fences (optional fields).36d7b290): typed examplespecinputs asinput.required<Spec>()to match the contract and codebase pattern.Scope notes
render/a2ui/*pages correctly attribute@threadplane/chat(no mis-import) — accuracy fixed in place; relocating them is a separate IA decision (spawned as a follow-up).api-docs.jsonhas its own signature drift — that's a generator bug, not a prose fix (spawned as a follow-up); generated JSON was not hand-edited.withViewsordering; the legitimate langgraph example ina2ui/overview.mdx).Test Plan
@threadplane/render; no stale envelope names in corrected pages; no inbound links to the one renamed anchor (#datamodelupdate-semantics).🤖 Generated with Claude Code