docs: custom component directory requires an init.py file

[mendonk]

Issue #9343 mentions that __init__.py is required for Langflow to detect custom components, and the docs examples don't include this. This PR adds them, and a troubleshooting entry for other users who might see this issue.

Summary by CodeRabbit

• Documentation
  • Updated documentation for custom components in Langflow
  • Added troubleshooting guide for custom components not appearing in the visual editor
  • Clarified directory structure requirements for component development
  • Provided guidance on resolving component loading issues

[coderabbitai]

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

The pull request updates documentation for Langflow's custom components, focusing on clarifying directory structure requirements, specifically emphasizing the need for an __init__.py file in category directories and providing troubleshooting guidance for component loading issues.

Changes

Cohort / File(s)	Change Summary
Documentation Updates, docs/docs/Components/components-custom-components.mdx, docs/docs/Support/troubleshooting.mdx	Added detailed instructions for custom component directory structure, emphasizing the requirement of __init__.py files in category directories

Estimated Code Review Effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly Related PRs

• docs: Promote MCP content in the left nav and revise the MCP connection component docs #8567: Documenting MCP connection component and server/client usage
• docs: how to add a missing dependency to langflow desktop #8942: Managing custom dependencies in Langflow Desktop
• fix(components): exclude base path from component loading and refine caching #8735: Improving custom component loading logic

Suggested Labels

size:M, lgtm

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs-custom-component-init-dir

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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.

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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.

[Victor-w-Madeira]

LGTM

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[github-actions]

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