docs: add partials for npx requirements and podman #10453
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 WalkthroughThis PR refactors documentation by extracting reusable MDX partial components. Two new partial files are created containing tip content for MCP Node setup and Podman alternatives. Four existing documentation pages are updated to import and render these partials, replacing inline tip blocks with component references. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested labels
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 3 inconclusive)
✅ Passed checks (3 passed)
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 |
github-actions
bot
added
documentation
This comment has been minimized.
This comment has been minimized.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/docs/Deployment/deployment-docker.mdx (1)
6-9: Move the Podman tip admonition after the introductory paragraph for better readability.The PartialPodmanAlt component is correctly defined and imported, but currently placed at line 8, before the introductory context. Since the tip references "all commands shown here," readers should understand the page's purpose first. Move the component to after line 10 (after "Running applications in Docker containers...") so the Podman alternative is presented after context is established.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
docs/docs/Agents/mcp-client.mdx(2 hunks)docs/docs/Agents/mcp-component-astra.mdx(1 hunks)docs/docs/Deployment/deployment-docker.mdx(1 hunks)docs/docs/Deployment/develop-application.mdx(1 hunks)docs/docs/_partial-mcp-node-tip.mdx(1 hunks)docs/docs/_partial-podman-alt.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)
docs/**/*.{md,mdx}: All Markdown/MDX pages must start with front matter including at least title and description; include sidebar_position for docs pages when applicable
Code blocks must specify a language and may include a title (```lang title="…")
Use sentence case for headings and keep paragraphs short and scannable
Write in second person, present tense, with a professional but approachable tone
Use inline code with backticks for code terms; use bold for UI elements and italics for emphasis; keep lists in parallel structure
Ensure internal links are functional and navigation works (update cross-references as needed)
Verify all code examples in docs and blog actually run as shown
Use correct terminology capitalization: Langflow, Component, Flow, API, JSON
Reference images with absolute paths under /img/... and provide descriptive alt text
Files:
docs/docs/_partial-podman-alt.mdxdocs/docs/Deployment/deployment-docker.mdxdocs/docs/_partial-mcp-node-tip.mdxdocs/docs/Agents/mcp-client.mdxdocs/docs/Deployment/develop-application.mdxdocs/docs/Agents/mcp-component-astra.mdx
docs/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)
Use Docusaurus admonitions (:::+tip|warning|danger) instead of custom callouts in docs pages
Files:
docs/docs/_partial-podman-alt.mdxdocs/docs/Deployment/deployment-docker.mdxdocs/docs/_partial-mcp-node-tip.mdxdocs/docs/Agents/mcp-client.mdxdocs/docs/Deployment/develop-application.mdxdocs/docs/Agents/mcp-component-astra.mdx
🧠 Learnings (9)
📓 Common learnings
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-09-30T00:09:51.631Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use Docusaurus admonitions (:::+tip|warning|danger) instead of custom callouts in docs pages
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-09-30T00:09:51.631Z
Learning: Applies to docs/docs/components/**/*.{md,mdx} : Component docs must follow the component page template with Overview, Configuration (Inputs/Outputs tables), Usage Example, and Common Issues sections
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-09-30T00:09:51.631Z
Learning: Applies to docs/sidebars.js : Keep sidebars.js updated to include new/changed docs sections and items using Docusaurus category structure
📚 Learning: 2025-06-23T12:46:52.420Z
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).
Applied to files:
docs/docs/Agents/mcp-client.mdxdocs/docs/Deployment/develop-application.mdxdocs/docs/Agents/mcp-component-astra.mdx
📚 Learning: 2025-06-23T12:46:42.048Z
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/frontend_development.mdc:0-0
Timestamp: 2025-06-23T12:46:42.048Z
Learning: Custom React Flow node types should be implemented as memoized components, using Handle components for connection points and supporting optional icons and labels.
Applied to files:
docs/docs/Agents/mcp-client.mdxdocs/docs/Deployment/develop-application.mdx
📚 Learning: 2025-06-16T11:14:04.200Z
Learnt from: dolfim-ibm
PR: langflow-ai/langflow#8394
File: src/frontend/src/icons/Docling/index.tsx:4-6
Timestamp: 2025-06-16T11:14:04.200Z
Learning: The Langflow codebase consistently uses `React.PropsWithChildren<{}>` as the prop type for all icon components using forwardRef, rather than `React.SVGProps<SVGSVGElement>`. This is an established pattern across hundreds of icon files in src/frontend/src/icons/.
Applied to files:
docs/docs/Agents/mcp-client.mdxdocs/docs/Deployment/develop-application.mdx
📚 Learning: 2025-07-23T21:19:22.567Z
Learnt from: deon-sanchez
PR: langflow-ai/langflow#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.
Applied to files:
docs/docs/Agents/mcp-client.mdxdocs/docs/Agents/mcp-component-astra.mdx
📚 Learning: 2025-09-30T00:09:51.631Z
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-09-30T00:09:51.631Z
Learning: Applies to docs/sidebars.js : Keep sidebars.js updated to include new/changed docs sections and items using Docusaurus category structure
Applied to files:
docs/docs/Deployment/develop-application.mdx
📚 Learning: 2025-07-18T18:27:12.609Z
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.
Applied to files:
docs/docs/Deployment/develop-application.mdx
📚 Learning: 2025-09-30T00:09:51.631Z
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-09-30T00:09:51.631Z
Learning: Applies to docs/**/*.{md,mdx} : Use correct terminology capitalization: Langflow, Component, Flow, API, JSON
Applied to files:
docs/docs/Deployment/develop-application.mdx
📚 Learning: 2025-07-18T18:27:12.609Z
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/icons/**/*.{ts,tsx,js,jsx} : Use Lucide React for icons in the frontend.
Applied to files:
docs/docs/Deployment/develop-application.mdx
⏰ 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). (2)
- GitHub Check: Test Docs Build / Test Docs Build
- GitHub Check: build-and-deploy
🔇 Additional comments (5)
docs/docs/_partial-podman-alt.mdx (1)
1-3: MDX partial structure and content are correct.The partial follows proper Docusaurus admonition formatting and is appropriately scoped for reuse across deployment documentation. The link to Podman documentation uses proper Markdown syntax.
docs/docs/Deployment/develop-application.mdx (1)
7-9: Partial import and rendering follow established patterns.The PartialPodmanAlt component is correctly imported and rendered at the top of the page, maintaining consistency with the deployment-docker.mdx page. The placement and syntax are appropriate.
docs/docs/Agents/mcp-component-astra.mdx (1)
7-13: Partial placement within procedural steps is contextually appropriate.The PartialMcpNodeTip is rendered after the Node.js installation step (step 1) and before the OpenAI setup (step 2), which logically aligns with the partial's content about Node.js prerequisites and Docker container setup. The import syntax is correct.
docs/docs/Agents/mcp-client.mdx (1)
8-39: Partial placement between procedure steps is clear and contextually sound.The PartialMcpNodeTip is rendered after explaining the STDIO, JSON, and SSE options for adding an MCP server (line 39), providing setup prerequisites and guidance at a natural pause point in the procedure. The import syntax and component placement are correct.
docs/docs/_partial-mcp-node-tip.mdx (1)
1-7: Links are correctly formatted and will resolve as intended.Both internal links in the partial follow the repository's established Docusaurus conventions and resolve correctly:
/develop-application#package-managementlinks to the page withslug: /develop-applicationand the heading "### Package management" (which converts to anchor#package-management)/mcp-component-astralinks to the page withslug: /mcp-component-astraBoth target pages exist at their expected locations, and the link format matches patterns used throughout the documentation.
github-actions
bot
added
documentation
|
Build successful! ✅ |
* add-partial-for-mcp-note * use-podman-option * reword
Create two partials and add them where applicable.
Summary by CodeRabbit