Skip to content

docs: improve custom components deployment and organization guide - #11450

Merged
mendonk merged 6 commits into
langflow-ai:mainfrom
AntonioABLima:docs/improve-docker-custom-components-guide
Jan 28, 2026
Merged

docs: improve custom components deployment and organization guide#11450
mendonk merged 6 commits into
langflow-ai:mainfrom
AntonioABLima:docs/improve-docker-custom-components-guide

Conversation

@AntonioABLima

@AntonioABLima AntonioABLima commented Jan 26, 2026

Copy link
Copy Markdown
Member

Summary

Fixes documentation issues that caused user confusion when deploying custom components with Docker. A user on Discord reported problems following the current documentation. After investigating and discussing the issue, we identified missing information about the required folder structure.

Changes:

  • Explicitly clarified that custom components must be placed inside category folders, not directly in base directory
  • Added concrete Dockerfile example showing how to copy components and set LANGFLOW_COMPONENTS_PATH
  • Enhanced custom components structure examples to show multiple components per category folder

Problem

When users don't create category folders and place custom components directly in /components, Langflow interprets them as directories and crashes when clicked.

Solution

Updated documentation to clearly state the category folder requirement and provide practical examples.

Files Changed

  • docs/docs/Deployment/develop-application.mdx: Added Docker setup instructions and category folder requirement
  • docs/docs/Components/components-custom-components.mdx: Improved folder structure examples

Summary by CodeRabbit

  • Documentation
    • Clarified custom component organization using category folder structure
    • Enhanced deployment instructions with step-by-step setup guide for organizing and deploying custom components
    • Added Docker configuration example for component deployment
    • Included reference link to component bundles documentation

✏️ Tip: You can customize this high-level summary in your review settings.

@AntonioABLima
AntonioABLima requested a review from mendonk January 26, 2026 18:55
@coderabbitai

coderabbitai Bot commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

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.

  • 🔍 Trigger a full review

Walkthrough

Documentation updates clarify component organization structure and deployment procedures. Changes expand guidance on placing components in category subfolders, add explicit Docker deployment steps for custom components, and provide clearer setup instructions for the categorized component layout.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/docs/Components/components-custom-components.mdx, docs/docs/Deployment/develop-application.mdx
Expanded component categorization guidance and added explicit deployment instructions. First file clarifies multiple components per category folder with added example file. Second file introduces structured category subfolder setup, removes imperative language, adds Docker COPY and LANGFLOW_COMPONENTS_PATH environment variable configuration example.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 7
✅ Passed checks (7 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: improving documentation for custom components deployment and organization, which directly aligns with the PR's core objective of clarifying component placement and Docker deployment.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Test Coverage For New Implementations ✅ Passed This PR contains only documentation updates to clarify deployment procedures and component organization guidelines, with no new code implementations, components, functionality, or bug fixes requiring test coverage.
Test Quality And Coverage ✅ Passed This pull request contains only documentation updates (.mdx files) with no new code implementations, functions, APIs, or functionality changes.
Test File Naming And Structure ✅ Passed This check is not applicable to the provided pull request. The PR exclusively modifies documentation files, which are Markdown documentation files. Since the PR does not include any test files, there are no test file naming, structure, or coverage requirements to assess.
Excessive Mock Usage Warning ✅ Passed The custom check for excessive mock usage is not applicable to this pull request because it exclusively modifies documentation files (.mdx files) without including any test files or test-related code changes.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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 documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 26, 2026
coderabbitai[bot]

This comment was marked as resolved.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 26, 2026
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 27, 2026

@mendonk mendonk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM, thank you @AntonioABLima

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 27, 2026
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 28, 2026
@mendonk
mendonk added this pull request to the merge queue Jan 28, 2026
Merged via the queue into langflow-ai:main with commit b474968 Jan 28, 2026
20 checks passed
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants