Skip to content

feat: improve long-term memory docs and discoverability#2957

Draft
Naomi Pentrel (npentrel) wants to merge 4 commits intomainfrom
open-swe/4ac2e594-9545-d401-760e-5bfd7515ad9b
Draft

feat: improve long-term memory docs and discoverability#2957
Naomi Pentrel (npentrel) wants to merge 4 commits intomainfrom
open-swe/4ac2e594-9545-d401-760e-5bfd7515ad9b

Conversation

@npentrel
Copy link
Contributor

Description

Improves the long-term memory documentation and its discoverability from the short-term memory page.

The long-term memory page was missing setup guidance — it jumped straight into the store API without showing how to connect a store to an agent. Users on the short-term memory page also had no way to discover that long-term memory exists, since it's in a different navigation section ("Advanced usage" vs "Core components").

Changes:

  • Short-term memory page: Added a <Tip> callout linking to long-term memory docs, placed after the overview section
  • Long-term memory page:
    • Added SEO description frontmatter
    • Rewrote overview to be clearer and link back to short-term memory
    • Added a new "Usage" section showing how to pass a store to create_agent (Python + JS)
    • Added "In production" subsection with PostgresStore examples (Python + JS), matching the pattern used on the short-term memory page
    • Added a <Tip> linking to the Memory conceptual guide for deeper reading
    • Added a "Related" section at the bottom with cross-links to short-term memory, conceptual guide, and persistence docs

Resolves DOC-800

Test Plan

  • Verify the short-term memory page shows the Tip callout linking to long-term memory
  • Verify the long-term memory page renders correctly with the new Usage and In production sections
  • Verify all internal links resolve correctly
  • Verify code examples use correct imports and API patterns (matched against existing examples in the codebase)

@github-actions github-actions bot added langchain For docs changes to LangChain internal oss labels Mar 6, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

Mintlify preview ID generated: preview-opensw-1772799916-b2b441c

@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

Mintlify preview ID generated: preview-opensw-1772802747-8eae154

@github-actions github-actions bot added javascript python For content related to the Python version of LangChain projects tests labels Mar 6, 2026
@npentrel Naomi Pentrel (npentrel) changed the title feat: improve long-term memory docs and discoverability [closes DOC-800] feat: improve long-term memory docs and discoverability Mar 6, 2026
@npentrel Naomi Pentrel (npentrel) force-pushed the open-swe/4ac2e594-9545-d401-760e-5bfd7515ad9b branch from 6f7bd8c to 0031054 Compare March 6, 2026 16:08
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

Mintlify preview ID generated: preview-opensw-1772813421-69b83ed

@npentrel Naomi Pentrel (npentrel) force-pushed the open-swe/4ac2e594-9545-d401-760e-5bfd7515ad9b branch from 0031054 to dac848a Compare March 6, 2026 16:45
@npentrel Naomi Pentrel (npentrel) force-pushed the open-swe/4ac2e594-9545-d401-760e-5bfd7515ad9b branch from dac848a to 1ec2014 Compare March 6, 2026 16:47
@github-actions github-actions bot added the ci label Mar 6, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

Mintlify preview ID generated: preview-opensw-1772815705-b78a17a

@github-actions github-actions bot removed the ci label Mar 6, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

Mintlify preview ID generated: preview-opensw-1772816278-0ffdd26

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal javascript langchain For docs changes to LangChain oss python For content related to the Python version of LangChain projects tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants