docs: refresh develop overview page#9177
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 deployment documentation was reorganized, with the main overview page condensed into a summary of deployment options linking to separate guides. Detailed technical instructions and architectural explanations were removed from the overview. The production best practices page was expanded to clarify the distinction between IDE and runtime deployment modes, including environment variable usage. Changes
Sequence Diagram(s)No sequence diagram generated as the changes are limited to documentation restructuring and content updates. Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Possibly related PRs
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
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: 3
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/docs/Deployment/deployment-overview.mdx(1 hunks)docs/docs/Deployment/deployment-prod-best-practices.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/Deployment/deployment-prod-best-practices.mdxdocs/docs/Deployment/deployment-overview.mdx
🧠 Learnings (3)
📓 Common learnings
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
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.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: All documentation changes must be built and served locally using yarn build and yarn serve before deployment.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Documentation is automatically deployed on commit to the main branch; build artifacts are output to the build/ directory and served via CDN.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: The documentation site is built and served locally using 'yarn build' and 'yarn serve', and is automatically deployed on commit to the main branch.
docs/docs/Deployment/deployment-prod-best-practices.mdx (7)
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
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-07-18T18:26:42.027Z
Learning: All documentation changes must be built and served locally using yarn build and yarn serve before deployment.
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.
Learnt from: deon-sanchez
PR: #9158
File: src/backend/base/langflow/api/v1/mcp_projects.py:404-404
Timestamp: 2025-07-23T21:19:22.567Z
Learning: In langflow MCP projects configuration, prefer using dynamically computed URLs (like the sse_url variable) over hardcoded localhost URLs to ensure compatibility across different deployment environments.
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.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/icons.mdc:0-0
Timestamp: 2025-06-23T12:46:52.420Z
Learning: When implementing a new component icon in Langflow, ensure the icon name is clear, recognizable, and used consistently across both backend (Python 'icon' attribute) and frontend (React/TypeScript mapping).
docs/docs/Deployment/deployment-overview.mdx (9)
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: Before deployment, documentation must be reviewed for accuracy, completeness, clarity, and navigation, including checking for broken links and up-to-date screenshots.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
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-07-18T18:26:42.027Z
Learning: All documentation changes must be built and served locally using yarn build and yarn serve before deployment.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Documentation is automatically deployed on commit to the main branch; build artifacts are output to the build/ directory and served via CDN.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: Documentation content should be concise, with short paragraphs and parallel structure in lists for better readability.
Learnt from: deon-sanchez
PR: #9158
File: src/backend/base/langflow/api/v1/mcp_projects.py:404-404
Timestamp: 2025-07-23T21:19:22.567Z
Learning: In langflow MCP projects configuration, prefer using dynamically computed URLs (like the sse_url variable) over hardcoded localhost URLs to ensure compatibility across different deployment environments.
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.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: The documentation site is built and served locally using 'yarn build' and 'yarn serve', and is automatically deployed on commit to the main branch.
🪛 LanguageTool
docs/docs/Deployment/deployment-prod-best-practices.mdx
[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ment for creating and testing flows. * Langflow runtime -...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ 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
| <!--TODO: Verify these scenarios--> | ||
| <!--You can host a Langflow server 24x7 and have all of your apps call that fixed server to run your flows. You can bundle the Langflow package as a dependency of a larger application and run the whole thing all together. You can containerize Langflow and serve it as a microservice for a larger application comprised of microservices like a website.--> No newline at end of file |
There was a problem hiding this comment.
Remove TODO placeholders before publishing
Lines 25-26 are editorial notes and should not ship with production docs. Either convert them into real content or delete them.
🤖 Prompt for AI Agents
In docs/docs/Deployment/deployment-overview.mdx at lines 25 to 26, remove the
TODO placeholder comments as they are editorial notes not meant for production.
Either rewrite these comments into finalized, clear content explaining the
deployment scenarios or delete them entirely to ensure the documentation is
clean and professional.
| Langflow can be deployed in two distinct environments. | ||
|
|
||
| * [Langflow IDE](/deployment-kubernetes-dev) - A development environment for creating and testing flows. | ||
| * [Langflow runtime](/deployment-kubernetes-prod) - A production environment for hosting and serving flows. | ||
|
|
||
| The **Langflow IDE** includes the frontend for visual development of your flow. The default [docker-compose.yml](https://github.com/langflow-ai/langflow/blob/main/docker_example/docker-compose.yml) file hosted in the Langflow repository builds the Langflow IDE image. The Langflow IDE can be deployed on [Docker](/deployment-docker) or [Kubernetes](/deployment-kubernetes-dev). | ||
|
|
||
| The **Langflow runtime** is a headless or backend-only mode. The server exposes your flow as an endpoint, and runs only the processes necessary to serve your flow, with PostgreSQL as the database for improved scalability. Use the Langflow **runtime** to deploy your flows if you don't require the frontend for visual development. The Langflow runtime can be deployed on [Docker](/deployment-docker) or [Kubernetes](/deployment-kubernetes-prod). | ||
|
|
||
| :::tip | ||
| You can start Langflow in headless mode with the [LANGFLOW_BACKEND_ONLY](/environment-variables#LANGFLOW_BACKEND_ONLY) environment variable. | ||
| ::: |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Front-matter missing description; minor style & repetition issues
– Add a description: line to comply with docs requirements.
– Three consecutive bullet sentences start with Langflow; re-phrase one to avoid monotonous repetition (flagged by LanguageTool).
– Capitalize Flow consistently inside prose (flow ➔ Flow).
Example fix:
---
title: Langflow architecture and best practices on Kubernetes
slug: /deployment-prod-best-practices
+description: Best-practice guidance for deploying Langflow IDE and runtime on Kubernetes and Docker.
---
Langflow can be deployed in two distinct environments:Please adjust and re-run yarn build.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Langflow can be deployed in two distinct environments. | |
| * [Langflow IDE](/deployment-kubernetes-dev) - A development environment for creating and testing flows. | |
| * [Langflow runtime](/deployment-kubernetes-prod) - A production environment for hosting and serving flows. | |
| The **Langflow IDE** includes the frontend for visual development of your flow. The default [docker-compose.yml](https://github.com/langflow-ai/langflow/blob/main/docker_example/docker-compose.yml) file hosted in the Langflow repository builds the Langflow IDE image. The Langflow IDE can be deployed on [Docker](/deployment-docker) or [Kubernetes](/deployment-kubernetes-dev). | |
| The **Langflow runtime** is a headless or backend-only mode. The server exposes your flow as an endpoint, and runs only the processes necessary to serve your flow, with PostgreSQL as the database for improved scalability. Use the Langflow **runtime** to deploy your flows if you don't require the frontend for visual development. The Langflow runtime can be deployed on [Docker](/deployment-docker) or [Kubernetes](/deployment-kubernetes-prod). | |
| :::tip | |
| You can start Langflow in headless mode with the [LANGFLOW_BACKEND_ONLY](/environment-variables#LANGFLOW_BACKEND_ONLY) environment variable. | |
| ::: | |
| --- | |
| title: Langflow architecture and best practices on Kubernetes | |
| slug: /deployment-prod-best-practices | |
| description: Best-practice guidance for deploying Langflow IDE and runtime on Kubernetes and Docker. | |
| --- | |
| Langflow can be deployed in two distinct environments. | |
| * [Langflow IDE](/deployment-kubernetes-dev) - A development environment for creating and testing flows. | |
| * [Langflow runtime](/deployment-kubernetes-prod) - A production environment for hosting and serving flows. | |
| The **Langflow IDE** includes the frontend for visual development of your Flow. The default [docker-compose.yml](https://github.com/langflow-ai/langflow/blob/main/docker_example/docker-compose.yml) file hosted in the Langflow repository builds the Langflow IDE image. The Langflow IDE can be deployed on [Docker](/deployment-docker) or [Kubernetes](/deployment-kubernetes-dev). | |
| The **Langflow runtime** is a headless or backend-only mode. The server exposes your Flow as an endpoint, and runs only the processes necessary to serve your Flow, with PostgreSQL as the database for improved scalability. Use the Langflow **runtime** to deploy your Flows if you don’t require the frontend for visual development. The Langflow runtime can be deployed on [Docker](/deployment-docker) or [Kubernetes](/deployment-kubernetes-prod). | |
| :::tip | |
| You can start Langflow in headless mode with the [LANGFLOW_BACKEND_ONLY](/environment-variables#LANGFLOW_BACKEND_ONLY) environment variable. | |
| ::: |
🧰 Tools
🪛 LanguageTool
[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ment for creating and testing flows. * Langflow runtime -...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🤖 Prompt for AI Agents
In docs/docs/Deployment/deployment-prod-best-practices.mdx around lines 9 to 20,
add a front-matter line for `description:` at the top of the file to meet
documentation standards. Rephrase one of the three consecutive bullet points
starting with "Langflow" to reduce repetitive phrasing and improve readability.
Also, capitalize all instances of "flow" to "Flow" within the prose for
consistent styling. After making these changes, run `yarn build` to verify the
documentation builds correctly.
aimurphy
left a comment
aimurphy
left a comment
There was a problem hiding this comment.
approved with some small comments
| <!--TODO: Verify these scenarios--> | ||
| <!--You can host a Langflow server 24x7 and have all of your apps call that fixed server to run your flows. You can bundle the Langflow package as a dependency of a larger application and run the whole thing all together. You can containerize Langflow and serve it as a microservice for a larger application comprised of microservices like a website.--> No newline at end of file |
There was a problem hiding this comment.
You can remove this comment now.
SonicDMG
temporarily deployed
to
docs-lfoss-1574 - langflow-manual-install PR #9177
Render
Destroyed
SonicDMG
temporarily deployed
to
docs-lfoss-1574 - langflow-manual-install PR #9177
Render
Destroyed
github-actions
Bot
added
documentation
|
Please retry analysis of this Pull-Request directly on SonarQube Cloud |
|
Build successful! ✅ |
|
Build successful! ✅ |
* content * docs-review
3 participants
Clarify methods of making your flow public and link out, and include why you might use them.
Move the Kubernetes content to the kubernetes page, which will be refreshed soon also.
Summary by CodeRabbit