docs: standardize assistantId on 'chat' to match shipped example#584
Merged
Conversation
The docs drifted between 'chat' (used in examples/chat/python/langgraph.json and the langgraph introduction page) and 'chat_agent' (used across guides, concepts, component, and api docs). All referred to the same generic default agent. Standardize on 'chat' so copy-pasted snippets work against the shipped example backend. Self-contained langgraph.json graph keys and the agent.fn.ts JSDoc example updated to match. Intentionally-distinct illustrative IDs (orchestrator, memory_agent, support_agent, etc.) left untouched. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
The docs drifted between two values for the LangGraph/chat assistant ID:
'chat'— used by the shipped example (examples/chat/python/langgraph.jsonregisters graph key"chat"), the 3 TypeScript examples, and the langgraph getting-started introduction page.'chat_agent'— used across langgraph guides/concepts, the chat component docs, the chat getting-started pages, and the api reference.Both referred to the same generic default agent, so a reader copying a snippet from one page and pairing it with the example backend would hit an
assistantIdmismatch. This standardizes everything on'chat'.Changes (25 swaps, prose/code-example only)
assistantId: 'chat_agent'→assistantId: 'chat'across docs.mdx.langgraph.jsongraph keys indeployment.mdx("chat_agent"→"chat") so each page stays internally consistent.// 'chat' maps to the key in your langgraph.json "graphs" config.libs/langgraph/src/lib/agent.fn.tsupdated to match (source-of-truth example developers copy).Intentionally left untouched
orchestrator,memory_agent,support_agent,copilot_agent,research_agent, etc.apps/website/public/whitepapers/angular-preview.html(point-in-time artifact, not living docs).Test Plan
chat_agentno longer present inapps/website/content/docs/orlibs/langgraph/src/lib/agent.fn.ts.chat_agent→chatswaps, no collateral changes (no headings/anchors/other API names touched).eslint libs/langgraph/src/lib/agent.fn.tsexits 0.🤖 Generated with Claude Code