Skip to content

docs: Touchup cloud provider deployment pages#9241

Merged
mendonk merged 5 commits into
mainfrom
lfoss-1578-2
Jul 30, 2025
Merged

docs: Touchup cloud provider deployment pages#9241
mendonk merged 5 commits into
mainfrom
lfoss-1578-2

Conversation

@aimurphy
Copy link
Copy Markdown
Collaborator

@aimurphy aimurphy commented Jul 30, 2025

Recreates #9232

Summary by CodeRabbit

  • Documentation
    • Improved clarity and consistency in references to environment variables across multiple documentation pages.
    • Enhanced and restructured deployment guides for Google Cloud Platform, Hugging Face Spaces, Railway, and Render, providing clearer step-by-step instructions and contextual information.
    • Updated sidebar navigation by grouping cloud platform deployment guides into a dedicated "Cloud platforms" category for easier access.

@SonicDMG SonicDMG temporarily deployed to lfoss-1578-2 - langflow-manual-install PR #9241 July 30, 2025 01:28 — with Render Destroyed
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 30, 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

This update revises documentation files for improved clarity, consistency, and formatting. It standardizes the referencing and linking of environment variables, restructures deployment guides for clarity, and updates the sidebar configuration to group cloud deployment options under a new "Cloud platforms" category. No code or API changes are included.

Changes

Cohort / File(s) Change Summary
Environment Variable Link Formatting
docs/docs/Components/components-custom-components.mdx, docs/docs/Components/components-data.mdx, docs/docs/Concepts/concepts-file-management.mdx, docs/docs/Configuration/environment-variables.mdx, docs/docs/Deployment/deployment-prod-best-practices.mdx, docs/docs/Develop/memory.mdx
Standardized the formatting and hyperlinking of environment variable references, removing anchor links and improving clarity in documentation.
Deployment Guide Restructuring
docs/docs/Deployment/deployment-gcp.mdx, docs/docs/Deployment/deployment-hugging-face-spaces.mdx, docs/docs/Deployment/deployment-railway.mdx, docs/docs/Deployment/deployment-render.mdx
Revised and expanded deployment documentation for GCP, Hugging Face Spaces, Railway, and Render. Improvements include clearer instructions, better formatting, expanded stepwise guidance, and updated links.
Sidebar Organization
docs/sidebars.js
Grouped cloud deployment documentation entries under a new "Cloud platforms" category in the sidebar, introducing an additional hierarchy for better navigation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested labels

documentation, lgtm

Suggested reviewers

  • mendonk
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch lfoss-1578-2

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 30, 2025
@aimurphy aimurphy removed their assignment Jul 30, 2025
@aimurphy aimurphy requested a review from mendonk July 30, 2025 01:29
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 30, 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: 3

🔭 Outside diff range comments (3)
docs/docs/Deployment/deployment-render.mdx (1)

1-4: Missing description in front-matter

Add a concise description to satisfy required metadata and avoid build warnings.

 ---
 title: Deploy Langflow on Render
+description: Deploy Langflow to Render with the one-click blueprint workflow.
 slug: /deployment-render
 ---
docs/docs/Deployment/deployment-gcp.mdx (1)

1-4: Front-matter lacks a description field

Include it to comply with docs guidelines and prevent Docusaurus front-matter errors.

 ---
 title: Deploy Langflow on Google Cloud Platform
+description: Use Cloud Shell to spin up a Debian VM and run Langflow on GCP.
 slug: /deployment-gcp
 ---
docs/docs/Deployment/deployment-prod-best-practices.mdx (1)

1-4: Missing description in front-matter block ― required by docs guidelines

All Markdown/MDX docs under docs/docs/** must begin with a front-matter block that includes both title and description.
Without the description field, the page will break SEO metadata generation and can be excluded from the sidebar build.

 ---
 title: Langflow architecture and best practices on Kubernetes
 slug: /deployment-prod-best-practices
+description: Learn how to run Langflow in production on Kubernetes with headless runtime, scaling, security, and environment isolation best practices.
 ---
🧹 Nitpick comments (3)
docs/docs/Configuration/environment-variables.mdx (1)

184-187: Port should be documented as an integer, not a string

LANGFLOW_REDIS_PORT represents a numeric TCP port but the Format column lists String.
Aligning the declared type with its semantic type avoids confusion and keeps the table consistent with other integer-based settings such as LANGFLOW_PORT.

-| `LANGFLOW_REDIS_PORT` | String | `6379` | See `LANGFLOW_CACHE_TYPE`. |
+| `LANGFLOW_REDIS_PORT` | Integer | `6379` | See `LANGFLOW_CACHE_TYPE`. |
docs/docs/Develop/memory.mdx (1)

75-85: Inconsistent capitalisation of default value for LANGFLOW_CACHE_TYPE

The quick-start snippet uses LANGFLOW_CACHE_TYPE=Async (capital “A”) while the canonical value in the environment-variables table is async (lowercase).
Unless the implementation is case-insensitive, pick one form (preferably async) to prevent copy-paste errors.

-LANGFLOW_CACHE_TYPE=Async
+LANGFLOW_CACHE_TYPE=async
docs/docs/Deployment/deployment-prod-best-practices.mdx (1)

15-16: Link directly to the env-var anchor for quicker navigation

Linking to the generic environment-variables page forces readers to search for LANGFLOW_BACKEND_ONLY.
Pointing to the specific anchor (as in the original docs) improves UX without losing consistency.

-You can start Langflow in headless mode with the `LANGFLOW_BACKEND_ONLY` [environment variable](/environment-variables).
+You can start Langflow in headless mode with the `LANGFLOW_BACKEND_ONLY` [environment variable](/environment-variables#langflow_backend_only).

Please confirm the anchor slug in /environment-variables.mdx is still #langflow_backend_only; update if it has changed.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c030743 and d19453c.

📒 Files selected for processing (11)
  • docs/docs/Components/components-custom-components.mdx (1 hunks)
  • docs/docs/Components/components-data.mdx (1 hunks)
  • docs/docs/Concepts/concepts-file-management.mdx (1 hunks)
  • docs/docs/Configuration/environment-variables.mdx (1 hunks)
  • docs/docs/Deployment/deployment-gcp.mdx (1 hunks)
  • docs/docs/Deployment/deployment-hugging-face-spaces.mdx (1 hunks)
  • docs/docs/Deployment/deployment-prod-best-practices.mdx (1 hunks)
  • docs/docs/Deployment/deployment-railway.mdx (1 hunks)
  • docs/docs/Deployment/deployment-render.mdx (1 hunks)
  • docs/docs/Develop/memory.mdx (1 hunks)
  • docs/sidebars.js (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
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.mdx
  • docs/docs/Configuration/environment-variables.mdx
  • docs/docs/Concepts/concepts-file-management.mdx
  • docs/docs/Develop/memory.mdx
  • docs/docs/Deployment/deployment-hugging-face-spaces.mdx
  • docs/docs/Components/components-custom-components.mdx
  • docs/docs/Components/components-data.mdx
  • docs/docs/Deployment/deployment-railway.mdx
  • docs/docs/Deployment/deployment-gcp.mdx
  • docs/docs/Deployment/deployment-render.mdx
docs/sidebars.js

📄 CodeRabbit Inference Engine (.cursor/rules/docs_development.mdc)

Sidebar navigation must be updated in docs/sidebars.js to reflect new or reorganized documentation content.

Files:

  • docs/sidebars.js
🧠 Learnings (12)
📓 Common learnings
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/sidebars.js : Sidebar navigation must be updated in docs/sidebars.js to reflect new or reorganized documentation content.
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-07-18T18:26:42.027Z
Learning: All documentation content must be accurate, complete, clear, and include cross-references between related topics.
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: 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: Headers in documentation should use sentence case, and formatting should include inline code with backticks, bold for UI elements, and italic for emphasis.
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} : 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.
docs/docs/Deployment/deployment-prod-best-practices.mdx (9)

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: 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: 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: Headers in documentation should use sentence case, and formatting should include inline code with backticks, bold for UI elements, and italic for emphasis.

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: ogabrielluiz
PR: langflow-ai/langflow#0
File: :0-0
Timestamp: 2025-06-26T19:43:18.260Z
Learning: In langflow custom components, the module_name parameter is now propagated through template building functions to add module metadata and code hashes to frontend nodes for better component tracking and debugging.

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} : Internal links in documentation must be functional and not broken.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Test Langflow's REST API endpoints in backend Python tests using the async client fixture and asserting response codes and payloads.

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.027Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.

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.

docs/docs/Concepts/concepts-file-management.mdx (3)

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: Applies to docs/docs/**/*.{md,mdx} : All images referenced in documentation must include descriptive alt text for accessibility.

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} : Internal links in documentation must be functional and not broken.

docs/docs/Develop/memory.mdx (5)

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-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: 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: Headers in documentation should use sentence case, and formatting should include inline code with backticks, bold for UI elements, and italic for emphasis.

docs/sidebars.js (4)

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/sidebars.js : Sidebar navigation must be updated in docs/sidebars.js to reflect new or reorganized documentation content.

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/docusaurus.config.js : Site configuration such as title, tagline, URL, and navbar items must be managed in docs/docusaurus.config.js.

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: Sidebar and navigation should be kept current to ensure users can easily find all documentation sections and cross-references.

docs/docs/Deployment/deployment-hugging-face-spaces.mdx (6)

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-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: Applies to docs/docs/**/*.{md,mdx} : 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.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: Headers in documentation should use sentence case, and formatting should include inline code with backticks, bold for UI elements, and italic for emphasis.

docs/docs/Components/components-custom-components.mdx (13)

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: ogabrielluiz
PR: langflow-ai/langflow#0
File: :0-0
Timestamp: 2025-06-26T19:43:18.260Z
Learning: In langflow custom components, the module_name parameter is now propagated through template building functions to add module metadata and code hashes to frontend nodes for better component tracking and debugging.

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: 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: Applies to docs/docs/components/**/*.{md,mdx} : Component documentation pages must follow the provided template, including sections for Overview, Configuration (Inputs/Outputs), Usage Example, and Common Issues.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: Headers in documentation should use sentence case, and formatting should include inline code with backticks, bold for UI elements, and italic for emphasis.

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).

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/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Applies to src/backend/base/langflow/components/**/*.py : Add new backend components to the appropriate subdirectory under src/backend/base/langflow/components/

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} : Internal links in documentation must be functional and not broken.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Applies to src/backend/base/langflow/components/**/init.py : Update init.py with alphabetical imports when adding new components

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/frontend_development.mdc:0-0
Timestamp: 2025-07-18T18:27:12.609Z
Learning: Applies to src/frontend/src/components//@(FlowGraph|nodes)//*.{ts,tsx,js,jsx} : Use React Flow for flow graph visualization components.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/frontend_development.mdc:0-0
Timestamp: 2025-07-18T18:27:12.609Z
Learning: Applies to src/frontend/src/**/*.{ts,tsx,js,jsx} : All frontend TypeScript and JavaScript code should be located under src/frontend/src/ and organized into components, pages, icons, stores, types, utils, hooks, services, and assets directories as per the specified directory layout.

docs/docs/Components/components-data.mdx (3)

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: Applies to docs/docs/**/*.{md,mdx} : Internal links in documentation must be functional and not broken.

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} : All images referenced in documentation must include descriptive alt text for accessibility.

docs/docs/Deployment/deployment-railway.mdx (3)

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: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.

docs/docs/Deployment/deployment-gcp.mdx (4)

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-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: 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.

docs/docs/Deployment/deployment-render.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-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: 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: 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.

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} : 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.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: Headers in documentation should use sentence case, and formatting should include inline code with backticks, bold for UI elements, and italic for emphasis.

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.

⏰ 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 (3)
docs/sidebars.js (1)

226-249: Cloud-platform category structure looks correct

The new “Cloud platforms” sub-category cleanly groups the four deployment docs and keeps the sidebar tidy. No broken IDs observed.

docs/docs/Deployment/deployment-railway.mdx (1)

1-23: LGTM – front-matter complete and instructions clear

The added description metadata and expanded, numbered steps follow the docs style guide. Image alt text and tracking parameters are present.

docs/docs/Components/components-custom-components.mdx (1)

236-239: LGTM – clearer wording and correct link target

The rephrased sentence correctly references LANGFLOW_COMPONENTS_PATH and links to the generic env-vars page, matching the new conventions.

Comment thread docs/docs/Components/components-data.mdx
Comment thread docs/docs/Concepts/concepts-file-management.mdx
Comment thread docs/docs/Deployment/deployment-hugging-face-spaces.mdx
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 30, 2025

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

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

github-actions Bot commented Jul 30, 2025

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

@SonicDMG SonicDMG temporarily deployed to lfoss-1578-2 - langflow-manual-install PR #9241 July 30, 2025 13:02 — with Render Destroyed
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 30, 2025
@sonarqubecloud
Copy link
Copy Markdown

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 30, 2025

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

Copy link
Copy Markdown
Collaborator

@mendonk mendonk left a comment

Choose a reason for hiding this comment

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

Approved.
The change to the env vars is a nice touch.

@github-actions github-actions Bot added the lgtm This PR has been approved by a maintainer label Jul 30, 2025
@mendonk mendonk added this pull request to the merge queue Jul 30, 2025
Merged via the queue into main with commit 47be23e Jul 30, 2025
17 checks passed
@mendonk mendonk deleted the lfoss-1578-2 branch July 30, 2025 13:20
2getsandesh pushed a commit to 2getsandesh/langflow-IBM that referenced this pull request Aug 6, 2025
* recreate 9232 because brokne build

* fix links

* fix nav level

---------

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
@coderabbitai coderabbitai Bot mentioned this pull request Aug 11, 2025
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