langchain-ai/docs
1
0
Fork 0
mirror of https://github.com/langchain-ai/docs.git synced 2026-07-22 12:25:55 -04:00
Code Issues 490 Packages Projects Releases Wiki Activity

[PR #3906] WIP-need-to sync with LG-Add DeltaChannel custom checkpointer guide #3915

New Issue
Open
opened 2026-06-05 18:53:34 -04:00 by yindo · 0 comments
yindo commented 2026-06-05 18:53:34 -04:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/docs/pull/3906
Author: @longquanzheng
Created: 5/7/2026
Status: 🔄 Open

Base: main ← Head: long/delta-chekpointer-guide

📝 Commits (1)

📊 Changes

3 files changed (+343 additions, -1 deletions)

View changed files

📝 src/docs.json (+7 -1)
➕ src/oss/python/integrations/checkpointers/delta-channel-guide.mdx (+330 -0)
📝 src/oss/python/integrations/checkpointers/index.mdx (+6 -0)

📄 Description

Overview

Adds a new Python integration page that helps third-party BaseCheckpointSaver authors support graphs using DeltaChannel (currently in beta).

The content is ported from the upstream guide in langchain-ai/langgraph, which lives next to the implementation but isn't surfaced on the public docs site. Hosting it under oss/python/integrations/checkpointers/ makes it discoverable to community checkpointer authors (Redis, Mongo, Cosmos, Aerospike, Cockroach, etc.) who need to know how to:

  1. Store _DeltaSnapshot blobs and pending writes correctly
  2. Override aget_delta_channel_history for performance
  3. Implement cleanup methods (prune, delete_for_runs, copy_thread) without silently corrupting delta history

Changes

  • New page: src/oss/python/integrations/checkpointers/delta-channel-guide.mdx — converted from upstream markdown into MDX with Mintlify components for friendlier display:
    • <Note> callout for the beta admonition
    • <Steps> for the parent-chain walk and cleanup recipes
    • <Tabs> for the three prune strategies (Compact-and-prune / Walk-to-boundary / Postgres SQL sketch)
    • <Accordion> for the optional Postgres copy_thread SQL example
    • <Warning> / <Tip> callouts for the silent-corruption hazard and Postgres optimization
    • Mermaid diagram restyled with the brand classDef palette
    • @[BaseCheckpointSaver], @[DeltaChannel], @[InMemorySaver], @[PostgresSaver], @[SqliteSaver] link-map references
  • Index update: src/oss/python/integrations/checkpointers/index.mdx — added a <Card> callout pointing to the new guide and an ## Available backends heading above the existing table
  • Navigation: src/docs.json — converted the lone Checkpointers entry under Open source → Python → Integrations → Integrations by component into a nested group containing both index and delta-channel-guide, so the guide appears in the left sidebar

Type of change

Type: New documentation page

Related issues/PRs

Checklist

  • I have read the contributing guidelines, including the language policy
  • I have tested my changes locally using docs dev
  • All code examples have been tested and work correctly
  • I have used root relative paths for internal links
  • I have updated navigation in src/docs.json if needed

Additional notes

Areas to review carefully

  • The mermaid diagram styling — please verify it renders correctly in dark mode
  • The conversion of Implementing prune → Implement prune style headings (per the workspace style guide's "active verb, not gerund" rule)
  • The decision to nest Checkpointers as a sub-group in docs.json rather than keeping it as a single index entry — this is the first integration component to use a sub-group, so it's worth confirming the sidebar UX is what we want

Local validation

  • make lint_prose FILES="..." → 0 errors / warnings / suggestions
  • make broken-links → no broken links

AI involvement

This PR was drafted with assistance from an AI coding agent. All content was reviewed and the source markdown was copied faithfully (no fabricated examples or guidance).

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/langchain-ai/docs/pull/3906 **Author:** [@longquanzheng](https://github.com/longquanzheng) **Created:** 5/7/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `long/delta-chekpointer-guide` --- ### 📝 Commits (1) - [`0e472b2`](https://github.com/langchain-ai/docs/commit/0e472b2b25589115d30579f5bd3ff4dd0c76b469) done ### 📊 Changes **3 files changed** (+343 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `src/docs.json` (+7 -1) ➕ `src/oss/python/integrations/checkpointers/delta-channel-guide.mdx` (+330 -0) 📝 `src/oss/python/integrations/checkpointers/index.mdx` (+6 -0) </details> ### 📄 Description ## Overview Adds a new Python integration page that helps third-party `BaseCheckpointSaver` authors support graphs using `DeltaChannel` (currently in beta). The content is ported from the upstream guide in [`langchain-ai/langgraph`](https://github.com/langchain-ai/langgraph/blob/a8ab1b16387cb5ea06e454b65791c1dfbfff78c1/docs/delta-channel-checkpointer-guide.md), which lives next to the implementation but isn't surfaced on the public docs site. Hosting it under `oss/python/integrations/checkpointers/` makes it discoverable to community checkpointer authors (Redis, Mongo, Cosmos, Aerospike, Cockroach, etc.) who need to know how to: 1. Store `_DeltaSnapshot` blobs and pending writes correctly 2. Override `aget_delta_channel_history` for performance 3. Implement cleanup methods (`prune`, `delete_for_runs`, `copy_thread`) without silently corrupting delta history ### Changes - **New page:** `src/oss/python/integrations/checkpointers/delta-channel-guide.mdx` — converted from upstream markdown into MDX with Mintlify components for friendlier display: - `<Note>` callout for the beta admonition - `<Steps>` for the parent-chain walk and cleanup recipes - `<Tabs>` for the three `prune` strategies (Compact-and-prune / Walk-to-boundary / Postgres SQL sketch) - `<Accordion>` for the optional Postgres `copy_thread` SQL example - `<Warning>` / `<Tip>` callouts for the silent-corruption hazard and Postgres optimization - Mermaid diagram restyled with the brand `classDef` palette - `@[BaseCheckpointSaver]`, `@[DeltaChannel]`, `@[InMemorySaver]`, `@[PostgresSaver]`, `@[SqliteSaver]` link-map references - **Index update:** `src/oss/python/integrations/checkpointers/index.mdx` — added a `<Card>` callout pointing to the new guide and an `## Available backends` heading above the existing table - **Navigation:** `src/docs.json` — converted the lone Checkpointers entry under *Open source → Python → Integrations → Integrations by component* into a nested group containing both `index` and `delta-channel-guide`, so the guide appears in the left sidebar ## Type of change **Type:** New documentation page ## Related issues/PRs - Upstream source: [`langchain-ai/langgraph` delta-channel-checkpointer-guide.md](https://github.com/langchain-ai/langgraph/blob/a8ab1b16387cb5ea06e454b65791c1dfbfff78c1/docs/delta-channel-checkpointer-guide.md) ## Checklist - [x] I have read the contributing guidelines, including the language policy - [x] I have tested my changes locally using `docs dev` - [x] All code examples have been tested and work correctly - [x] I have used **root relative** paths for internal links - [x] I have updated navigation in `src/docs.json` if needed ## Additional notes ### Areas to review carefully - The mermaid diagram styling — please verify it renders correctly in dark mode - The conversion of `Implementing prune` → `Implement prune` style headings (per the workspace style guide's "active verb, not gerund" rule) - The decision to nest `Checkpointers` as a sub-group in `docs.json` rather than keeping it as a single index entry — this is the first integration component to use a sub-group, so it's worth confirming the sidebar UX is what we want ### Local validation - `make lint_prose FILES="..."` → 0 errors / warnings / suggestions - `make broken-links` → no broken links ### AI involvement This PR was drafted with assistance from an AI coding agent. All content was reviewed and the source markdown was copied faithfully (no fabricated examples or guidance). --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-05 18:53:34 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
deepagents
docs-infra
external
external
help wanted
integration
internal
internal
javascript
js/ts
langchain
langgraph
langsmith
needs-title
pull-request
Mirrored from GitHub Pull Request
 python
reference
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#3915
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?