docs: align public api guidance#754
Merged
Merged
Conversation
Root cause of intermittent mid-stream character loss (tables collapsing to raw pipes): accumulateContent's string-prefix dedupe guard drops any delta that coincidentally prefixes the accumulated message — every bare "|" token in a table. Proven by byte-identical replay of captured wire events. Fix: merge by declared event kind (tuple=delta → unconditional append; messages/partial=snapshot → prefix reconcile) with an identity-based canonical-id backstop replacing the text heuristic. TDD via the existing bridge spec harness + a live 3-layer Chrome MCP gate. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
5 tasks: red tests via the existing bridge spec harness, mode-aware merge (delta=append, snapshot=prefix reconcile) + canonical-id backstop, cross- suite gates, a REQUIRED live Chrome MCP gate (wire==accumulation across ≥6 table runs, temp recorder reverted), PR + merge. Spec refined: values-sync keeps snapshot semantics (lagging mid-run state must not rewind or mark canonical); finality is marked only by the canonical reasoning+text shape. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
|
Claude encountered an error after 2m 2s —— View job PR Review in Progress
|
Contributor
|
Claude encountered an error after 2m 19s —— View job PR Review in Progress
|
Contributor
|
Claude encountered an error after 1m 59s —— View job PR Review in Progress
|
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.
Summary
PR 1 of the Threadplane docs/website alignment program: API drift baseline.
Base commit:
3d3c8525075be79c4ce151a08d3b47828be861d5Head commit:
4a94a81eFixed confirmed public API/package guidance drift:
libs/chat/README.mdfrom the non-exportedagent({ graphId })LangGraph factory example to the currentprovideAgent({ apiUrl, assistantId })+injectAgent()pattern.libs/chat/package.json: adds@angular/router,zod, optionalkatex, and removes stale@angular/formsguidance.@threadplane/langgraph, matching the adapter imported by the snippets.libs/ag-ui/package.json: adds@ag-ui/coreand removes non-peer@threadplane/licensing.assistantIdto runnable LangGraphprovideAgentexamples touched by this audit.surfaceToSpecimport/signature claim and corrected A2UI root-selection behavior docs to match implementation.ChangeDetectionStrategy.Deferred Follow-Ups
These are intentionally not fixed in PR 1 because they need broader docs-generator or package-docs decisions:
@threadplane/telemetry/browsergenerated API coverage:npm run generate-api-docsstill warns thatlibs/telemetry/src/browser/public-api.tsis not included by the node tsconfig. A probe confirmed the browser entry point is collectable withtsconfig.lib.browser.json, but telemetry has duplicate public type names across entry points, so this needs a generator/docs design decision.@threadplane/middlewarewebsite docs/API surface: the package is public and has a README/source API, but no website docs library. This belongs in the package-depth PR unless explicitly pulled forward.Verification
npm run generate-api-docs- PASS. Generated no diff. Existing telemetry browser TypeDoc warning remains and is deferred above.npx nx build website- PASS.npx nx lint chat- PASS with existing warnings.npx nx lint ag-ui- PASS with existing warnings.npx nx lint langgraph- PASS with existing warnings.npx nx build chat- PASS.npx nx build ag-ui- PASS.npx nx build langgraph- PASS.git diff --check- PASS.Review Notes
Subagent review gates completed:
The untracked planning files under
docs/superpowers/are intentionally not part of this PR per repo guidance.