Skip to content

docs: refresh memory page#9751

Merged
mendonk merged 6 commits into
mainfrom
docs-lfoss-1571-memory-management
Sep 10, 2025
Merged

docs: refresh memory page#9751
mendonk merged 6 commits into
mainfrom
docs-lfoss-1571-memory-management

Conversation

@mendonk
Copy link
Copy Markdown
Collaborator

@mendonk mendonk commented Sep 8, 2025

Preview

  • Clarify cache configuration options.
  • Reorganize and expand the database table descriptions.
  • Update the documentation for database connection and caching environment variables.
  • Move cache config from env vars to memory page.

Summary by CodeRabbit

  • Documentation
    • Expanded environment variables docs: new/updated entries for DB connection settings (including JSON-based configuration and connect timeout), retry behavior, API key tracking, starter projects, worker/timeout, SSL, and auth options.
    • Marked legacy DB pool variables as deprecated in favor of centralized settings.
    • Updated caching docs to reflect Langflow/Langchain cache options with clearer, generic guidance.
    • Added structured sections for connection pool parameters and cache environment variables.
    • Refreshed storage tables and terminology (e.g., ApiKey, File, Folder, Transactions, User).

@mendonk mendonk requested a review from aimurphy September 8, 2025 20:30
@mendonk mendonk self-assigned this Sep 8, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 8, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Documentation updates reorganize environment variables and memory configuration. Redis-specific guidance is reduced or moved, new database connection settings and pooling parameters are documented, and tables/sections are restructured for clarity. Storage tables list is adjusted. No code or public API changes.

Changes

Cohort / File(s) Summary of Changes
Environment variables docs
docs/docs/Configuration/environment-variables.mdx
Reworked cache docs to reference internal Langflow and LangChain caching; removed Redis-specific env var guidance; added/updated DB connection settings (including centralized JSON), connection retry/timeout, starter project flags, and other env vars; marked some DB pool vars deprecated; minor link/text tweaks.
Memory and storage docs
docs/docs/Develop/memory.mdx
Updated storage tables (ApiKey, File, Folder, Flow, Message, Transactions, User, Variables); restructured external memory configuration with separate “Connection Pool Parameters” and “Separate Connection Settings”; standardized defaults/units; added “Cache Environment Variables” table; adjusted casing (async) and surrounding context.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

documentation, lgtm

Suggested reviewers

  • aimurphy
  • jordanrfrazier
  • Empreiteiro

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title references a real part of the changeset (refreshing the memory page) but omits the significant updates to the environment-variables documentation, so while partially related it does not fully summarize the main changes.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-lfoss-1571-memory-management

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 8, 2025
@github-actions

This comment has been minimized.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 8, 2025
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (3)
docs/docs/Develop/memory.mdx (1)

1-4: Add required frontmatter description.

Docs under docs/docs/ must include title and description. Add a concise description for SEO and build consistency.

Apply:

 ---
 title: Memory management options
 slug: /memory
+description: Configure local and external storage, chat memory, and caching options in Langflow.
 ---
docs/docs/Configuration/environment-variables.mdx (2)

1-4: Add required frontmatter description.

Include a description field to comply with docs frontmatter requirements.

Apply:

 ---
 title: Environment variables
 slug: /environment-variables
+description: Learn how to set, import, and manage Langflow environment variables and their precedence.
 ---

158-174: Fix brand casing in environment variables doc

-| `LANGFLOW_LANGCHAIN_CACHE` | String | `InMemoryCache` | Set the cache type for Langchain's caching system. For detailed cache configuration options, see [Configure cache memory](/memory#configure-cache-memory). |
+| `LANGFLOW_LANGCHAIN_CACHE` | String | `InMemoryCache` | Set the cache type for LangChain's caching system. For detailed cache configuration options, see [Configure cache memory](/memory#configure-cache-memory). |
🧹 Nitpick comments (1)
docs/docs/Develop/memory.mdx (1)

90-100: Align Redis env vars across docs and correct branding

  • Redis variables (LANGFLOW_REDIS_*) are documented in docs/docs/Develop/memory.mdx but missing from the “Environment variables” section in other docs (develop-application.mdx, troubleshooting.mdx). Either add them there (with supported status) or deprecate/remove them here.
  • Rename header to sentence case:
    -### Cache Environment Variables
    +### Cache environment variables
  • Fix branding in the table:
    -| `LANGFLOW_LANGCHAIN_CACHE` | String | `InMemoryCache` | Set the cache type for Langchain's caching system. |
    +| `LANGFLOW_LANGCHAIN_CACHE` | String | `InMemoryCache` | Set the cache type for LangChain's caching system. |
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a90bece and 214bfbd.

📒 Files selected for processing (2)
  • docs/docs/Configuration/environment-variables.mdx (2 hunks)
  • docs/docs/Develop/memory.mdx (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)

docs/docs/**/*.{md,mdx}: All documentation content must be written in Markdown or MDX files located under docs/docs/, following the prescribed directory structure for guides, reference, how-to, concepts, and API documentation.
All documentation Markdown and MDX files must begin with a frontmatter block including at least title and description fields.
Use admonitions (:::tip, :::warning, :::danger) in Markdown/MDX files to highlight important information, warnings, or critical issues.
All images referenced in documentation must include descriptive alt text for accessibility.
All code examples included in documentation must be tested and verified to work as shown.
Internal links in documentation must be functional and not broken.
Content must follow the style guide: professional but approachable tone, second person voice, present tense, short paragraphs, sentence case headers, inline code with backticks, bold for UI elements, italic for emphasis, and parallel structure in lists.
Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.

Files:

  • docs/docs/Develop/memory.mdx
  • docs/docs/Configuration/environment-variables.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Test Docs Build / Test Docs Build
  • GitHub Check: build-and-deploy
🔇 Additional comments (2)
docs/docs/Develop/memory.mdx (1)

29-41: The next step is verifying that the “Message” anchor exists in data-types.mdx. Please run:

#!/bin/bash
# Check for heading defining 'Message' in data-types.mdx
echo "Checking for '## Message' or '### Message' heading in data-types.mdx"
rg -nP '^#{2,6}\s*Message' -C1 docs/docs/Concepts/data-types.mdx || echo "No Message heading found"
docs/docs/Configuration/environment-variables.mdx (1)

163-167: Ensure DB settings defaults and wording match Memory page.

Confirm the defaults and semantics for LANGFLOW_DB_CONNECTION_SETTINGS and LANGFLOW_DB_CONNECT_TIMEOUT match the values shown on the Memory page (counts vs seconds, and SQLite note).

Provide a single source of truth or cross-reference to avoid drift.

Comment thread docs/docs/Develop/memory.mdx Outdated
Comment thread docs/docs/Develop/memory.mdx
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 8, 2025
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 8, 2025
@github-actions

This comment has been minimized.

1 similar comment
@github-actions

This comment has been minimized.

Copy link
Copy Markdown
Collaborator

@aimurphy aimurphy left a comment

Choose a reason for hiding this comment

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

approved with a few small comments

Comment thread docs/docs/Develop/memory.mdx Outdated
Comment thread docs/docs/Develop/memory.mdx
Comment thread docs/docs/Develop/memory.mdx Outdated
@github-actions github-actions Bot added the lgtm This PR has been approved by a maintainer label Sep 9, 2025
Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 10, 2025
@github-actions

This comment has been minimized.

@mendonk mendonk requested a review from italojohnny September 10, 2025 17:34
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 10, 2025
@sonarqubecloud
Copy link
Copy Markdown

@github-actions github-actions Bot removed the documentation Improvements or additions to documentation label Sep 10, 2025
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 10, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Sep 10, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@mendonk mendonk added this pull request to the merge queue Sep 10, 2025
Merged via the queue into main with commit 46e58c9 Sep 10, 2025
19 checks passed
@mendonk mendonk deleted the docs-lfoss-1571-memory-management branch September 10, 2025 18:06
lucaseduoli pushed a commit that referenced this pull request Sep 16, 2025
* update-memory-page

* move-cache-values-to-memory-page

* db-connection-settings

* space

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* clarify-cache-options

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants