Skip to content

docs(adapters): integrate thread-loading design into existing guides#470

Merged
blove merged 1 commit into
mainfrom
claude/docs-adapter-thread-loading
May 19, 2026
Merged

docs(adapters): integrate thread-loading design into existing guides#470
blove merged 1 commit into
mainfrom
claude/docs-adapter-thread-loading

Conversation

@blove
Copy link
Copy Markdown
Contributor

@blove blove commented May 19, 2026

Summary

Three contextual touches that explain how thread loading differs between adapters — woven into existing docs where developers are already looking, not appended as new sections.

Where this lives

Doc Touch
`chat/guides/writing-an-adapter.mdx` — `AgentWithHistory (Optional)` New subsection `Hydrating from a server-stored thread` naming the parallel behavioral choice every adapter must make (the structural `history` field is the what; hydrate-on-threadId-change is the when)
`ag-ui/concepts/architecture.mdx` — `Provider choices` Clarifies `threadId` is a plain string consumed at construction (not a Signal), explains the protocol stance, names the two switching patterns
`ag-ui/concepts/architecture.mdx` — `Current scope` out-of-scope bullet Expands "History and time-travel" with why (protocol, not TODO) + back/forward cross-links
`agent/guides/persistence.mdx` — top of file One callout framing this whole guide as adapter-defined behavior, with a cross-link to writing-an-adapter for the broader design context

Why this approach

A developer arriving at any of these three docs from a different starting point — adapter author, AG-UI consumer, LangGraph consumer — now finds the thread-loading story explained at the level they care about, with consistent cross-links between the three sources. No standalone "Thread loading" doc that competes with any of them.

Test plan

  • `pnpm nx run website:lint` — green
  • Visual review in the Fumadocs preview after deploy

🤖 Generated with Claude Code

Three contextual touches — no new sections.

writing-an-adapter.mdx (Agent contract, chat docs)
  AgentWithHistory section already covers the structural choice. Adds a
  'Hydrating from a server-stored thread' subsection naming the parallel
  behavioral choice every adapter author has to make ('should
  threadId-change repopulate messages from the server?') and shows how
  the two reference adapters answer it differently: LangGraph yes via
  client.threads.getHistory; AG-UI no because the protocol carries
  events not snapshots. Cross-links both adapter docs.

ag-ui/concepts/architecture.mdx
  Provider choices section now clarifies threadId is a plain string
  consumed at construction (not a Signal) and names the two patterns
  AG-UI consumers use to switch threads: recreate the provider via
  re-injection, or use the LangGraph adapter. The existing 'History
  and time-travel out of scope' bullet is expanded to explain *why*
  (protocol-level, not a TODO) with a back-link to Provider choices
  and a forward-link to the Writing an Adapter guide.

agent/guides/persistence.mdx
  Adds a single callout at the top framing this whole guide as
  adapter-defined behavior the LangGraph adapter implements because
  the LangGraph protocol supports it. Cross-links to writing-an-adapter
  for adapter authors who want the design context. Rest of the page
  stays LangGraph-focused.
@vercel
Copy link
Copy Markdown

vercel Bot commented May 19, 2026

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

Project Deployment Actions Updated (UTC)
threadplane Ready Ready Preview, Comment May 19, 2026 6:34pm

Request Review

@blove blove merged commit 19aa104 into main May 19, 2026
18 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