docs: Update memory and storage configuration guide#10318
Conversation
…to correct directory structure 📝 (memory.mdx): Improve formatting and consistency in storage path descriptions for different environments 📝 (memory.mdx): Clarify instructions for configuring external PostgreSQL database for Langflow storage 📝 (memory.mdx): Enhance readability and organization of database connection pool settings information 📝 (memory.mdx): Update cache memory configuration variables table for clarity and consistency 📝 (memory.mdx): Refactor and reorganize information on storing chat memory for better understanding and readability
WalkthroughDocumentation update to memory configuration guide covering Langflow Desktop storage path changes on Windows (com.Langflow to com.LangflowDesktop), along with formatting and minor textual rewording adjustments. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (2 inconclusive)
✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
github-actions
Bot
added
the
documentation
|
|
Build successful! ✅ |
github-actions
Bot
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/docs/Develop/memory.mdx (2)
85-86: Consider shortening wordy phrasing.The phrase "in excess of" can be more concisely expressed as "beyond" or "over". This improves readability without changing meaning.
- `max_overflow`: Maximum number of connections that can be created in excess of `pool_size` if needed. Default: 30. + `max_overflow`: Maximum number of connections that can be created beyond `pool_size` if needed. Default: 30.
171-173: Reduce phrasing repetition in the third-party chat memory component description.Lines 171–173 repeat "if you want to use" and "database" in close proximity, reducing clarity. Consider restructuring to improve variety and flow.
- **Third-party chat memory components**: Use one of these components only if you need to store or retrieve chat memories from a dedicated external chat memory database. - Typically, this is necessary only if you have specific storage needs that aren't met by Langflow storage. - For example, if you want to manage chat memory data by directly working with the database, or if you want to use a different database than the default Langflow storage. + **Third-party chat memory components**: Use one of these components only if you need to store or retrieve chat memories from a dedicated external chat memory database. + Typically, this is necessary only if you have specific storage needs that aren't met by Langflow storage. + For example, use these components if you need to directly manage chat memory data or store memories in an alternative database system.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/docs/Develop/memory.mdx(4 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)
docs/**/*.{md,mdx}: All Markdown/MDX pages must start with front matter including at least title and description; include sidebar_position for docs pages when applicable
Code blocks must specify a language and may include a title (```lang title="…")
Use sentence case for headings and keep paragraphs short and scannable
Write in second person, present tense, with a professional but approachable tone
Use inline code with backticks for code terms; use bold for UI elements and italics for emphasis; keep lists in parallel structure
Ensure internal links are functional and navigation works (update cross-references as needed)
Verify all code examples in docs and blog actually run as shown
Use correct terminology capitalization: Langflow, Component, Flow, API, JSON
Reference images with absolute paths under /img/... and provide descriptive alt text
Files:
docs/docs/Develop/memory.mdx
docs/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)
Use Docusaurus admonitions (:::+tip|warning|danger) instead of custom callouts in docs pages
Files:
docs/docs/Develop/memory.mdx
🪛 LanguageTool
docs/docs/Develop/memory.mdx
[style] ~86-~86: ‘in excess of’ might be wordy. Consider a shorter alternative.
Context: ...mber of connections that can be created in excess of pool_size if needed. Default: 30. -...
(EN_WORDINESS_PREMIUM_IN_EXCESS_OF)
[style] ~173-~173: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ly working with the database, or if you want to use a different database than the defau...
(REP_WANT_TO_VB)
⏰ 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 (1)
docs/docs/Develop/memory.mdx (1)
1-4: Verify front matter completeness per documentation guidelines.The coding guidelines require front matter with at least
titleanddescription, plussidebar_positionfor docs pages. The provided front matter includestitleandslug, butdescriptionandsidebar_positionare not shown. Please confirm these are present or add them if missing.
| - `LANGFLOW_DB_CONNECT_TIMEOUT`: The number of seconds to wait before giving up on a lock to be released or establishing a connection to the database. This may be separate from the `pool_timeout` in `LANGFLOW_DB_CONNECTION_SETTINGS`. Default: 30. | ||
|
|
||
| * `LANGFLOW_DB_CONNECTION_SETTINGS`: A a JSON dictionary containing the following database connection pool settings: | ||
| - `LANGFLOW_DB_CONNECTION_SETTINGS`: A a JSON dictionary containing the following database connection pool settings: |
There was a problem hiding this comment.
Fix typo in environment variable description.
Line 83 contains a duplicate article: "A a JSON dictionary" should be "A JSON dictionary".
- `LANGFLOW_DB_CONNECTION_SETTINGS`: A a JSON dictionary containing the following database connection pool settings:
+ `LANGFLOW_DB_CONNECTION_SETTINGS`: A JSON dictionary containing the following database connection pool settings:🤖 Prompt for AI Agents
In docs/docs/Develop/memory.mdx around line 83, fix the typo in the environment
variable description by removing the duplicate article: change "A a JSON
dictionary" to "A JSON dictionary" so the sentence reads correctly.
1 participant
This pull request updates the documentation for Langflow's memory and storage configuration. The main focus is on clarifying default storage paths, environment variable usage, and improving formatting for better readability. The most important changes are grouped below:
Storage Path Updates:
C:\Users\<name>\AppData\Roaming\com.LangflowDesktop\data\database.dbfor accuracy.Formatting and Readability Improvements:
Component and Usage Documentation:
Summary by CodeRabbit