-
Notifications
You must be signed in to change notification settings - Fork 8.4k
docs: improve custom components deployment and organization guide #11450
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
docs: improve custom components deployment and organization guide #11450
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
WalkthroughDocumentation 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 7✅ Passed checks (7 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
mendonk
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thank you @AntonioABLima
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:
LANGFLOW_COMPONENTS_PATHProblem
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 requirementdocs/docs/Components/components-custom-components.mdx: Improved folder structure examplesSummary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.