docs: user feedback items#9122
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe documentation was updated across multiple files to clarify and expand details on default storage locations for databases, logs, and configuration files, with distinctions based on platform and installation method. Additional clarifications were added regarding MCP flow requirements and agent memory behavior. No changes were made to exported or public code entities. Changes
Estimated code review effort1 (~6 minutes) Suggested labels
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
github-actions
Bot
added
the
documentation
|
CONFIG_DIR may change with #8656 |
github-actions
Bot
added
documentation
|
Build successful! ✅ |
![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
🔭 Outside diff range comments (2)
docs/docs/Concepts/mcp-server.mdx (1)
1-4: Front-matter must include adescriptionfieldThe docs guidelines require every page to start with at least
titleanddescription.
Please add a concise description to avoid breaking the docs build and search index.--- title: Use Langflow as an MCP server slug: /mcp-server +description: Learn how to expose Langflow flows as MCP server tools and connect clients. ---docs/docs/Tutorials/mcp-tutorial.mdx (1)
1-4: Add missingdescriptionin front-matterSame issue as above—lack of a
descriptionviolates docs lint rules.--- title: Connect to MCP servers from your application slug: /mcp-tutorial +description: Tutorial for wiring MCP servers into a Langflow application and calling them from code. ---
🧹 Nitpick comments (9)
docs/docs/Concepts/mcp-server.mdx (1)
28-31: Capitalize “Flow” in admonition titlePer the style guide, always capitalize Flow.
MCP flow requirements→MCP Flow requirements.-:::important MCP flow requirements +:::important MCP Flow requirementsdocs/docs/Tutorials/mcp-tutorial.mdx (1)
36-38: Capitalize “Flow” in admonition titleMaintain consistent terminology:
MCP Flow requirements.-:::important MCP flow requirements +:::important MCP Flow requirementsdocs/docs/Develop/memory.mdx (1)
52-53: Fix typo in alt-text
Redit→Redis.- +docs/docs/Develop/logging.mdx (1)
12-15: Minor formatting & consistency issues
- Add a space after the colon so the Markdown renders correctly.
- Keep path bullets consistent with the Memory page (include “(Python version may vary)” for the
site-packagesentry).- Replace
<username>vs<name>mismatch.-**macOS Desktop**:`/Users/<username>/.langflow/cache` +**macOS Desktop**: `/Users/<username>/.langflow/cache` -**Windows Desktop**:`C:\Users\<username>\AppData\Roaming\com.Langflow\cache` +**Windows Desktop**: `C:\Users\<username>\AppData\Roaming\com.Langflow\cache` -**OSS macOS/Windows/Linux/WSL (uv pip install)**: `<path_to_venv>/lib/python3.12/site-packages/langflow/cache` +**OSS macOS/Windows/Linux/WSL (uv pip install)**: `<path_to_venv>/lib/python3.X/site-packages/langflow/cache` (Python version may vary)docs/docs/Components/components-helpers.mdx (2)
58-64: Align path list wording with other pagesTo avoid reader confusion, adopt the same bullet terminology used elsewhere (“macOS Desktop”, “Windows Desktop”, etc.) and keep the Python-version note.
-**Windows Desktop**: `C:\Users\<name>\AppData\Roaming\com.Langflow\data\langflow.db` +**Windows Desktop**: `C:\Users\<username>\AppData\Roaming\com.Langflow\data\langflow.db`
78-81: Typo: RedisThe component example references “Redit Chat Memory”. Replace with “Redis Chat Memory” for consistency with component names.
docs/docs/Configuration/environment-variables.mdx (1)
195-195: Consistency & spacingSame bullet list comments as earlier: add spaces after colons, update
<username>placeholder, and mention “Python version may vary” for thesite-packagespath.docs/docs/Concepts/concepts-flows.mdx (2)
86-89: Replace hard-coded Python version with a placeholder for maintainabilityUsing the explicit
python3.12segment hard-codes the documentation to a single Python release. Readers running a different version may assume the path is incorrect. Swap the literal version for a<python_version>placeholder (or similar) to keep the docs future-proof.- **OSS macOS/Windows/Linux/WSL (uv pip install)**: `<path_to_venv>/lib/python3.12/site-packages/langflow/cache` + **OSS macOS/Windows/Linux/WSL (uv `pip install`)**: `<path_to_venv>/lib/python<python_version>/site-packages/langflow/cache`
86-89: Tighten wording for clarity & consistency“uv pip install” reads like a shell fragment rather than prose and may puzzle newcomers. Consider rephrasing to match the other bullet labels:
- **OSS macOS/Windows/Linux/WSL (uv pip install)**: + **OSS macOS/Windows/Linux/WSL (installed with `uv pip`)**:This keeps the action (
installed with …) explicit and the tooling (uv) formatted as inline code, aligning with the style guide’s emphasis on clarity and consistent inline-code formatting.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
docs/docs/Agents/agents.mdx(1 hunks)docs/docs/Components/components-helpers.mdx(1 hunks)docs/docs/Concepts/concepts-flows.mdx(1 hunks)docs/docs/Concepts/mcp-server.mdx(1 hunks)docs/docs/Configuration/environment-variables.mdx(1 hunks)docs/docs/Develop/logging.mdx(1 hunks)docs/docs/Develop/memory.mdx(1 hunks)docs/docs/Tutorials/mcp-tutorial.mdx(1 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/logging.mdxdocs/docs/Concepts/mcp-server.mdxdocs/docs/Tutorials/mcp-tutorial.mdxdocs/docs/Components/components-helpers.mdxdocs/docs/Agents/agents.mdxdocs/docs/Configuration/environment-variables.mdxdocs/docs/Concepts/concepts-flows.mdxdocs/docs/Develop/memory.mdx
🧠 Learnings (8)
📓 Common learnings
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.011Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: Before deployment, documentation must be reviewed for accuracy, completeness, clarity, and navigation, including checking for broken links and up-to-date screenshots.
docs/docs/Develop/logging.mdx (3)
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.011Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: When writing documentation for Langflow using Docusaurus, always use professional but approachable tone, second person voice for instructions, and present tense for current features.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: All terminology such as 'Langflow', 'Component', 'Flow', 'API', and 'JSON' must be capitalized or uppercased as specified in the terminology section.
docs/docs/Concepts/mcp-server.mdx (1)
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.011Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.
docs/docs/Tutorials/mcp-tutorial.mdx (2)
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.011Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: All terminology such as 'Langflow', 'Component', 'Flow', 'API', and 'JSON' must be capitalized or uppercased as specified in the terminology section.
docs/docs/Components/components-helpers.mdx (1)
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.092Z
Learning: Applies to src/backend/tests/**/*.py : Test Langflow's Message objects and chat functionality in backend Python tests by asserting correct instantiation and property values.
docs/docs/Configuration/environment-variables.mdx (3)
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.011Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: When writing documentation for Langflow using Docusaurus, always use professional but approachable tone, second person voice for instructions, and present tense for current features.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: All terminology such as 'Langflow', 'Component', 'Flow', 'API', and 'JSON' must be capitalized or uppercased as specified in the terminology section.
docs/docs/Concepts/concepts-flows.mdx (3)
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.011Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: When writing documentation for Langflow using Docusaurus, always use professional but approachable tone, second person voice for instructions, and present tense for current features.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: All terminology such as 'Langflow', 'Component', 'Flow', 'API', and 'JSON' must be capitalized or uppercased as specified in the terminology section.
docs/docs/Develop/memory.mdx (2)
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.011Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.474Z
Learning: Applies to src/backend/base/langflow/services/database/models/**/*.py : Place database models in src/backend/base/langflow/services/database/models/
⏰ 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). (1)
- GitHub Check: build-and-deploy
🔇 Additional comments (1)
docs/docs/Develop/memory.mdx (1)
20-24: Confirm DB file location accuracy
<path_to_clone>/src/backend/base/langflow/langflow.dbmay not match the runtime-created DB path (often placed insidelangflow/only whenSAVE_DB_IN_CONFIG_DIRisfalse).
Please verify this path (and the identical lists in other docs) against the value returned bylangflow.settings.get_config_dir()/ "langflow.db"; otherwise users will look in the wrong place.
aimurphy
left a comment
aimurphy
left a comment
There was a problem hiding this comment.
couple of questions but otherwise LGTM. Very useful info to have.
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
removed
the
documentation
github-actions
Bot
added
the
documentation
|
Build successful! ✅ |
edwinjosechittilappilly
left a comment
edwinjosechittilappilly
left a comment
There was a problem hiding this comment.
LGTM. Agent Memory looks Good.
Approving with comments.
|
@edwinjosechittilappilly Confirming starting with |
* db-location-and-agent-memory * cleanup * postgresql-for-agent-memory * postgresql-in-message-history * remove-mcp-tutorial-note
3 participants
Addressing some items from user feedback:
Summary by CodeRabbit