Skip to content

docs(render): technical review — fix accuracy across all 18 render pages#590

Merged
blove merged 10 commits into
mainfrom
claude/render-docs-technical-review
Jun 6, 2026
Merged

docs(render): technical review — fix accuracy across all 18 render pages#590
blove merged 10 commits into
mainfrom
claude/render-docs-technical-review

Conversation

@blove
Copy link
Copy Markdown
Contributor

@blove blove commented Jun 6, 2026

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

  • a2ui (ebe716c3): surface-store.mdx used obsolete A2UI envelope names (createSurface/updateComponents/updateDataModel) — corrected to the real protocol (surfaceUpdate/dataModelUpdate/beginRendering/deleteSurface, per libs/a2ui). catalog.mdx documented wrong component props — fixed Button (childKeys/primary), TextField (text), Slider (minValue/maxValue), DateTimeInput (enableDate/enableTime), CheckBox (value), removed nonexistent Card title, and corrected a flat→keyed-union Text example.
  • guides (b04aa7d7): documented the previously-missing getFallback() method + fallback-rendering behavior; clarified ChatComponent is from @threadplane/chat.
  • api (29592752): documented getFallback() and RenderContext.emitEvent; fixed the signalStateStore signature.
  • concepts (bc68c2a3): completed the A2uiSurface / A2uiActionMessage type fences (optional fields).
  • getting-started (36d7b290): typed example spec inputs as input.required<Spec>() to match the contract and codebase pattern.

Scope notes

  • The 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).
  • The generated api-docs.json has its own signature drift — that's a generator bug, not a prose fix (spawned as a follow-up); generated JSON was not hand-edited.
  • Two suspected issues were verified as non-issues and left untouched (withViews ordering; the legitimate langgraph example in a2ui/overview.mdx).

Test Plan

  • Every fix re-verified against its cited source line by an independent reviewer subagent (5/5 section reviews PASS).
  • All 18 render routes return HTTP 200.
  • No a2ui surface API attributed to @threadplane/render; no stale envelope names in corrected pages; no inbound links to the one renamed anchor (#datamodelupdate-semantics).
  • Diffs scoped to the findings — no unrelated prose/heading/link/component changes.

🤖 Generated with Claude Code

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 6, 2026

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

Project Deployment Actions Updated (UTC)
threadplane Ready Ready Preview, Comment Jun 6, 2026 5:51pm

Request Review

@blove blove enabled auto-merge (squash) June 6, 2026 17:47
@blove blove merged commit 322e060 into main Jun 6, 2026
22 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