Skip to content

Refresh LangGraph install guidance#764

Merged
blove merged 1 commit into
mainfrom
codex/threadplane-langgraph-docs-audit
Jul 7, 2026
Merged

Refresh LangGraph install guidance#764
blove merged 1 commit into
mainfrom
codex/threadplane-langgraph-docs-audit

Conversation

@blove

@blove blove commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Update LangGraph install guidance across package README, website docs, prompt recipes, public agent context, and /llms.txt to include required LangChain peers and chat markdown support where the snippet renders .
  • Fix the LangGraph README thread adapter refresh example to call refresh().
  • Regenerate LangGraph API docs after correcting the provideFakeAgent() JSDoc example from responses to tokens.

Validation

  • npm run generate-api-docs
  • npm run generate-agent-context
  • npx nx run-many -t lint,test,type-tests,build -p langgraph
  • npx nx run-many -t lint,build -p website
  • npx nx e2e website --skip-nx-cache

@vercel

vercel Bot commented Jul 7, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
threadplane Ready Ready Preview, Comment Jul 7, 2026 12:47am

Request Review

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated approval: this PR received an intelligent (AI) code review. See the review comments on this PR.

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Claude finished @blove's task in 2m 50s —— View job


PR Review

  • Gather context
  • Read PR diff
  • Review source files
  • Post findings

Summary

Docs-only PR with two real bug fixes. Changes are correct. One minor inconsistency worth noting.


Bug fixes — both correct

threadsAdapter.refresh() fix (libs/langgraph/README.md:162)

The old example called threadsAdapter.loadThreads(), which doesn't exist on LangGraphThreadsAdapter. The actual public method is refresh() (confirmed in threads-adapter.ts:89). This was a broken copy-paste in the README.

provideFakeAgent JSDoc fix (libs/langgraph/src/lib/testing/provide-fake-agent.ts:19)

responsestokens matches the actual FakeAgentConfig interface (libs/chat/testing/fake-agent-config.ts:10). The old JSDoc would silently be ignored at runtime since the responses key isn't recognised.


Peer deps additions — correct

@langchain/core and @langchain/langgraph-sdk are both declared peers of @threadplane/langgraph (libs/langgraph/package.json). Adding them explicitly to install snippets is accurate and helps strict package managers (pnpm, Yarn strict-mode).


Minor: marked included in some LangGraph install snippets but not others

marked is a required (non-optional) peer dep of @threadplane/chat. The LangGraph quickstart and installation MDX pages now include @threadplane/chat in their install command but still omit marked:

# langgraph/getting-started/installation.mdx and quickstart.mdx
npm install @threadplane/langgraph @threadplane/chat @langchain/core @langchain/langgraph-sdk
#                                  ^^^ has marked as a required peer, not listed

Meanwhile the landing page (docs/page.tsx) and llms.txt do include marked for the LangGraph stack. Users with strict package managers following the LangGraph getting-started docs will get a peer dep prompt for marked that the text doesn't anticipate — the quickstart's "strict package managers may also ask you to install Angular and RxJS peers" sentence doesn't mention marked.

This is minor (npm auto-installs it; the user can follow the chat docs which do include it), but the quickstart's peer-dep disclaimer could mention marked for completeness: Fix this →


Generated/derived files

api-docs.json, AGENTS.md, CLAUDE.md, and public/ copies are all downstream of the source changes and look fine — no review concerns there.


Overall the PR is clean. The two bug fixes are accurate and the peer-deps docs update is correct. The marked omission from LangGraph-specific install commands is a minor inconsistency, not a blocker.

@blove blove merged commit cda8481 into main Jul 7, 2026
63 checks passed
@blove blove deleted the codex/threadplane-langgraph-docs-audit branch July 7, 2026 01:05
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