docs: Audit use of tabs and details #9196
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 update applies extensive formatting and structural improvements across documentation files. The main changes involve replacing tab components with native HTML Changes
Sequence Diagram(s)Omitted: Changes are documentation-only and do not introduce or modify control flow or features. Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested labels
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
Documentation and Community
|
github-actions
bot
added
documentation
|
Build successful! ✅ |
github-actions
bot
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🔭 Outside diff range comments (6)
docs/docs/API-Reference/api-reference-api-examples.mdx (2)
22-23: Typo: “Langfow” → “Langflow”.Minor spelling error in user-visible text.
105-107: Malformed URL in example curl command.The extra
$before?streamproduces the literal string$?stream=false.- --url "$LANGFLOW_SERVER_URL/api/v1/run/$FLOW_ID$?stream=false" \ + --url "$LANGFLOW_SERVER_URL/api/v1/run/$FLOW_ID?stream=false" \docs/docs/Develop/develop-application.mdx (1)
198-210: Unclosed code fence breaks subsequent Markdown renderingThe ```bash block opened on line 198 is never closed before the
<details>section begins, which will cause the rest of the page to be rendered as part of the code block.@@ - }' - + }' +``` + <details>docs/docs/API-Reference/api-logs.mdx (1)
6-8: Remove unusedTabs/TabItemimportsAfter migrating to
<details>theTabsandTabItemcomponents are no longer referenced, but they are still imported. Keeping unused imports can raise MDX/ESLint warnings.-import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +docs/docs/API-Reference/api-users.mdx (1)
66-83: Fix invalid JSON in “Get current user” exampleThe response object has a trailing comma before the closing brace, which would make the snippet fail if copied into tooling that validates JSON.
"last_login_at": "2025-05-29T15:06:56.157016", -} +}Please scan the other result blocks in this file for the same issue—several user objects also end with trailing commas.
Also applies to: 69-80
docs/docs/API-Reference/api-projects.mdx (1)
148-160: Invalid JSON in “Update project” responseThere is a trailing comma after the last property inside the object, which renders the JSON invalid.
"parent_id": null -} +}
🧹 Nitpick comments (13)
docs/docs/API-Reference/api-reference-api-examples.mdx (3)
1-4: Add adescriptionfield to the front-matter.The style-guide mandates at least
titleanddescriptionin every doc file.
Example:--- title: Get started with the Langflow API slug: /api-reference-api-examples +description: Learn how to make basic requests to the Langflow REST API and inspect typical responses. ---
6-7: Remove unused MDX imports.
TabsandTabItemare no longer referenced in this file. Deleting them avoids dead code and speeds MDX compilation.-import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem';
97-102: Duplicate environment-variable assignment.
LANGFLOW_API_KEYis exported twice. Drop the second line to avoid confusion.-export LANGFLOW_API_KEY="sk..." ... -export LANGFLOW_API_KEY="sk-..."docs/docs/API-Reference/api-flows-run.mdx (2)
1-4: Front-matter missingdescription.Add a concise summary per documentation guidelines.
6-8: Delete unusedTabs/TabItemimports.No tab components are used after the recent refactor.
-import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem';docs/docs/Concepts/concepts-file-management.mdx (2)
1-4: Adddescriptionto front-matter.Required by the docs style-guide.
21-22: Redundant word “page”.Reads “Projects page page”. Drop the second occurrence.
-* In the Langflow UI, on the [**Projects** page](/concepts-flows#projects) page, click **My Files** +* In the Langflow UI, on the [**Projects** page](/concepts-flows#projects), click **My Files**docs/docs/Components/components-data.mdx (1)
1-4: Missingdescriptionfield.Please add one for consistency.
docs/docs/Concepts/data-types.mdx (2)
1-4: Front-matter needs adescription.Add a short descriptive sentence.
6-8: Consider removing unusedTabsimport if grouping is not required.If no other
Tabsexist outside the shown snippet, you can safely drop the import.-import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import TabItem from '@theme/TabItem';docs/docs/API-Reference/api-users.mdx (1)
6-8: Remove unused imports
TabsandTabItemare no longer referenced after converting the examples to<details>blocks. Keeping them introduces dead code and may trigger MDX / eslint warnings.-import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem';docs/docs/Tutorials/chat-with-files.mdx (1)
7-8: Drop unused tab importsAfter the switch to native
<details>elements, these imports are redundant.-import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem';docs/docs/API-Reference/api-projects.mdx (1)
6-8: Unused tab importsSame pattern as in the Users doc—please remove to avoid MDX warnings.
-import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem';
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (34)
docs/docs/API-Reference/api-build.mdx(4 hunks)docs/docs/API-Reference/api-files.mdx(10 hunks)docs/docs/API-Reference/api-flows-run.mdx(4 hunks)docs/docs/API-Reference/api-flows.mdx(10 hunks)docs/docs/API-Reference/api-logs.mdx(4 hunks)docs/docs/API-Reference/api-monitor.mdx(9 hunks)docs/docs/API-Reference/api-projects.mdx(10 hunks)docs/docs/API-Reference/api-reference-api-examples.mdx(3 hunks)docs/docs/API-Reference/api-users.mdx(8 hunks)docs/docs/Agents/agents-tools.mdx(1 hunks)docs/docs/Components/components-data.mdx(1 hunks)docs/docs/Components/components-vector-stores.mdx(0 hunks)docs/docs/Concepts/concepts-file-management.mdx(1 hunks)docs/docs/Concepts/concepts-overview.mdx(1 hunks)docs/docs/Concepts/concepts-playground.mdx(3 hunks)docs/docs/Concepts/concepts-publish.mdx(4 hunks)docs/docs/Concepts/data-types.mdx(3 hunks)docs/docs/Concepts/mcp-server.mdx(3 hunks)docs/docs/Configuration/configuration-api-keys.mdx(6 hunks)docs/docs/Configuration/configuration-authentication.mdx(2 hunks)docs/docs/Configuration/configuration-global-variables.mdx(1 hunks)docs/docs/Configuration/environment-variables.mdx(5 hunks)docs/docs/Contributing/contributing-how-to-contribute.mdx(3 hunks)docs/docs/Deployment/deployment-kubernetes-prod.mdx(2 hunks)docs/docs/Develop/Clients/typescript-client.mdx(5 hunks)docs/docs/Develop/develop-application.mdx(1 hunks)docs/docs/Get-Started/get-started-installation.mdx(2 hunks)docs/docs/Get-Started/get-started-quickstart.mdx(9 hunks)docs/docs/Integrations/Arize/integrations-arize.mdx(3 hunks)docs/docs/Integrations/Docling/integrations-docling.mdx(4 hunks)docs/docs/Integrations/Google/integrations-google-big-query.mdx(3 hunks)docs/docs/Tutorials/agent.mdx(2 hunks)docs/docs/Tutorials/chat-with-files.mdx(1 hunks)docs/docs/Tutorials/chat-with-rag.mdx(3 hunks)
💤 Files with no reviewable changes (1)
- docs/docs/Components/components-vector-stores.mdx
🧰 Additional context used
📓 Path-based instructions (1)
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/Develop/develop-application.mdxdocs/docs/Components/components-data.mdxdocs/docs/API-Reference/api-flows-run.mdxdocs/docs/API-Reference/api-reference-api-examples.mdxdocs/docs/API-Reference/api-flows.mdxdocs/docs/Integrations/Google/integrations-google-big-query.mdxdocs/docs/API-Reference/api-users.mdxdocs/docs/Configuration/configuration-api-keys.mdxdocs/docs/Concepts/concepts-playground.mdxdocs/docs/Concepts/concepts-file-management.mdxdocs/docs/Concepts/concepts-overview.mdxdocs/docs/Configuration/configuration-global-variables.mdxdocs/docs/Integrations/Arize/integrations-arize.mdxdocs/docs/Tutorials/chat-with-rag.mdxdocs/docs/API-Reference/api-projects.mdxdocs/docs/Concepts/data-types.mdxdocs/docs/API-Reference/api-logs.mdxdocs/docs/Deployment/deployment-kubernetes-prod.mdxdocs/docs/Integrations/Docling/integrations-docling.mdxdocs/docs/Concepts/concepts-publish.mdxdocs/docs/API-Reference/api-build.mdxdocs/docs/Tutorials/chat-with-files.mdxdocs/docs/Concepts/mcp-server.mdxdocs/docs/Tutorials/agent.mdxdocs/docs/Get-Started/get-started-installation.mdxdocs/docs/Contributing/contributing-how-to-contribute.mdxdocs/docs/Agents/agents-tools.mdxdocs/docs/API-Reference/api-monitor.mdxdocs/docs/API-Reference/api-files.mdxdocs/docs/Develop/Clients/typescript-client.mdxdocs/docs/Get-Started/get-started-quickstart.mdxdocs/docs/Configuration/environment-variables.mdxdocs/docs/Configuration/configuration-authentication.mdx
🧠 Learnings (33)
📓 Common learnings
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-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-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: 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/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-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-07-18T18:26:42.027Z
Learning: Applies to docs/docs/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.
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 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.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: Images and screenshots in documentation should have descriptive alt text and filenames, and should highlight relevant UI elements.
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-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.
docs/docs/Develop/develop-application.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: namastex888
PR: #9018
File: src/frontend/src/modals/apiModal/utils/get-curl-code.tsx:139-184
Timestamp: 2025-07-11T21:32:57.160Z
Learning: In TypeScript/JavaScript cURL code generation for Langflow, PowerShell commands must use backticks () for line continuation and follow the pattern: curl --request POST ` followed by --url, --header flags on separate lines. Unix commands use backslashes () for line continuation. File upload commands should maintain platform-specific formatting just like other cURL commands in the codebase.
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/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Starter project files auto-format after langflow run; these formatting changes can be committed or ignored
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/Components/components-data.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/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-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/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.md : Create comprehensive unit tests for all new components. If unit tests are incomplete, create a Markdown file with manual testing steps in the same directory as the unit tests, using the same filename as the component but with a '.md' extension.
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 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.
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 documentation Markdown and MDX files must begin with a frontmatter block including at least title and description fields.
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.
docs/docs/API-Reference/api-flows-run.mdx (2)
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.
docs/docs/API-Reference/api-reference-api-examples.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/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.
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 code examples included in documentation must be tested and verified to work as shown.
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} : All documentation Markdown and MDX files must begin with a frontmatter block including at least title and description fields.
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: All terminology such as 'Langflow', 'Component', 'Flow', 'API', and 'JSON' must be capitalized or uppercased as specified in the terminology section.
docs/docs/API-Reference/api-flows.mdx (15)
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: 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: 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: 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/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.
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/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/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: 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: namastex888
PR: #9018
File: src/frontend/src/modals/apiModal/utils/get-curl-code.tsx:139-184
Timestamp: 2025-07-11T21:32:57.160Z
Learning: In TypeScript/JavaScript cURL code generation for Langflow, PowerShell commands must use backticks () for line continuation and follow the pattern: curl --request POST ` followed by --url, --header flags on separate lines. Unix commands use backslashes () for line continuation. File upload commands should maintain platform-specific formatting just like other cURL commands in the codebase.
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-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.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/frontend_development.mdc:0-0
Timestamp: 2025-06-23T12:46:42.048Z
Learning: React Flow should be used for flow graph visualization, with nodes and edges passed as props, and changes handled via onNodesChange and onEdgesChange callbacks.
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 flows using predefined JSON data and utility functions such as 'create_flow', 'build_flow', 'get_build_events', and 'consume_and_assert_stream' in backend Python tests.
docs/docs/Integrations/Google/integrations-google-big-query.mdx (2)
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/sidebars.js : Sidebar navigation must be updated in docs/sidebars.js to reflect new or reorganized documentation content.
docs/docs/API-Reference/api-users.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/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.
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-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/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-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/Configuration/configuration-api-keys.mdx (11)
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/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-07-18T18:26:42.027Z
Learning: Applies to docs/docs/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.
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: 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/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} : 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: 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/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: 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.
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-playground.mdx (8)
Learnt from: namastex888
PR: #9018
File: src/frontend/src/modals/apiModal/codeTabs/code-tabs.tsx:244-244
Timestamp: 2025-07-11T22:12:46.255Z
Learning: In src/frontend/src/modals/apiModal/codeTabs/code-tabs.tsx, the inconsistent showLineNumbers setting between Step 1 (false) and Step 2 (true) in the API modal is intentional to prevent breaking the modal height. Step 1 uses showLineNumbers={false} to save vertical space while Step 2 uses showLineNumbers={true} for better readability of longer code.
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/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} : 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-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-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-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.
docs/docs/Concepts/concepts-file-management.mdx (7)
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/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/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: Sidebar and navigation should be kept current to ensure users can easily find all documentation sections and cross-references.
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 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.
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: Starter project files auto-format after langflow run; these formatting changes can be committed or ignored
docs/docs/Concepts/concepts-overview.mdx (2)
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.
docs/docs/Configuration/configuration-global-variables.mdx (2)
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: 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.
docs/docs/Integrations/Arize/integrations-arize.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/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-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.
docs/docs/Tutorials/chat-with-rag.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: 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/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Starter project files auto-format after langflow run; these formatting changes can be committed or ignored
docs/docs/API-Reference/api-projects.mdx (14)
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/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.
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/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/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/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Starter project files auto-format after langflow run; these formatting changes can be committed or ignored
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-07-18T18:26:42.027Z
Learning: Applies to 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.
Learnt from: namastex888
PR: #9018
File: src/frontend/src/modals/apiModal/utils/get-curl-code.tsx:139-184
Timestamp: 2025-07-11T21:32:57.160Z
Learning: In TypeScript/JavaScript cURL code generation for Langflow, PowerShell commands must use backticks () for line continuation and follow the pattern: curl --request POST ` followed by --url, --header flags on separate lines. Unix commands use backslashes () for line continuation. File upload commands should maintain platform-specific formatting just like other cURL commands in the codebase.
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.
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/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/Concepts/data-types.mdx (1)
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/API-Reference/api-logs.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/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.
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-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-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} : 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 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.
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} : 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-07-18T18:26:42.027Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use admonitions (:::tip, :::warning, :::danger) in Markdown/MDX files to highlight important information, warnings, or critical issues.
docs/docs/Deployment/deployment-kubernetes-prod.mdx (2)
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.
docs/docs/Integrations/Docling/integrations-docling.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-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: 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-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 content must be accurate, complete, clear, and include cross-references between related topics.
docs/docs/Concepts/concepts-publish.mdx (8)
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-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-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/frontend_development.mdc:0-0
Timestamp: 2025-06-23T12:46:42.048Z
Learning: React Flow should be used for flow graph visualization, with nodes and edges passed as props, and changes handled via onNodesChange and onEdgesChange callbacks.
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: 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/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.
docs/docs/API-Reference/api-build.mdx (14)
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/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.
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: Applies to 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.
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-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-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-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 flows using predefined JSON data and utility functions such as 'create_flow', 'build_flow', 'get_build_events', and 'consume_and_assert_stream' in backend Python tests.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.487Z
Learning: Applies to src/backend/tests/unit/**/*.py : Test component integration within flows using create_flow, build_flow, and get_build_events utilities
Learnt from: namastex888
PR: #9018
File: src/frontend/src/modals/apiModal/utils/get-curl-code.tsx:139-184
Timestamp: 2025-07-11T21:32:57.160Z
Learning: In TypeScript/JavaScript cURL code generation for Langflow, PowerShell commands must use backticks () for line continuation and follow the pattern: curl --request POST ` followed by --url, --header flags on separate lines. Unix commands use backslashes () for line continuation. File upload commands should maintain platform-specific formatting just like other cURL commands in the codebase.
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.
docs/docs/Concepts/mcp-server.mdx (5)
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-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-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: ogabrielluiz
PR: #8590
File: Makefile:78-81
Timestamp: 2025-06-17T15:52:33.765Z
Learning: In the UV tool ecosystem, uv and uvx are the same thing - uvx is part of the uv installation, so checking for uv availability also ensures uvx is available.
docs/docs/Tutorials/agent.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-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.
docs/docs/Get-Started/get-started-installation.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-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.
docs/docs/Contributing/contributing-how-to-contribute.mdx (22)
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-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} : 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-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: 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-07-18T18:26:42.027Z
Learning: Applies to 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.
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-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: 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/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Starter project files auto-format after langflow run; these formatting changes can be committed or ignored
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/frontend_development.mdc:0-0
Timestamp: 2025-06-23T12:46:42.048Z
Learning: Frontend code must be formatted using the make format_frontend command and linted with make lint before committing changes.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/frontend_development.mdc:0-0
Timestamp: 2025-07-18T18:27:12.609Z
Learning: Run make format_frontend and make lint before committing any frontend changes.
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//*.py,tests//*.py,Makefile} : Run make format_backend to format Python code before linting or committing changes
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/frontend_development.mdc:0-0
Timestamp: 2025-06-23T12:46:42.048Z
Learning: Frontend builds must be performed using Vite, with production output placed in the dist/ directory and served by the backend in production 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//*.py,tests//*.py,Makefile} : Run make lint to perform linting checks on backend Python code
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/@(package*.json|tsconfig.json|tailwind.config.|vite.config.) : Frontend configuration files such as package.json, tsconfig.json, and Tailwind/Vite configs must be maintained and updated as needed.
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} : Format all TypeScript and JavaScript code using the make format_frontend command.
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: Applies to docs/docs/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.
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.
docs/docs/Agents/agents-tools.mdx (2)
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: 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/
docs/docs/API-Reference/api-monitor.mdx (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/docs/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.
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} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.
Learnt from: namastex888
PR: #9018
File: src/frontend/src/modals/apiModal/codeTabs/code-tabs.tsx:244-244
Timestamp: 2025-07-11T22:12:46.255Z
Learning: In src/frontend/src/modals/apiModal/codeTabs/code-tabs.tsx, the inconsistent showLineNumbers setting between Step 1 (false) and Step 2 (true) in the API modal is intentional to prevent breaking the modal height. Step 1 uses showLineNumbers={false} to save vertical space while Step 2 uses showLineNumbers={true} for better readability of longer code.
docs/docs/API-Reference/api-files.mdx (11)
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/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.
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 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.
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-07-18T18:26:42.027Z
Learning: Applies to docs/docs/**/*.{md,mdx} : All documentation Markdown and MDX files must begin with a frontmatter block including at least title and description fields.
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} : Use admonitions (:::tip, :::warning, :::danger) in Markdown/MDX files to highlight important information, warnings, or critical issues.
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-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.
Learnt from: namastex888
PR: #9018
File: src/frontend/src/modals/apiModal/utils/get-curl-code.tsx:139-184
Timestamp: 2025-07-11T21:32:57.160Z
Learning: In TypeScript/JavaScript cURL code generation for Langflow, PowerShell commands must use backticks () for line continuation and follow the pattern: curl --request POST ` followed by --url, --header flags on separate lines. Unix commands use backslashes () for line continuation. File upload commands should maintain platform-specific formatting just like other cURL commands in the codebase.
docs/docs/Develop/Clients/typescript-client.mdx (7)
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-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/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: namastex888
PR: #9018
File: src/frontend/src/modals/apiModal/utils/get-curl-code.tsx:139-184
Timestamp: 2025-07-11T21:32:57.160Z
Learning: In TypeScript/JavaScript cURL code generation for Langflow, PowerShell commands must use backticks () for line continuation and follow the pattern: curl --request POST ` followed by --url, --header flags on separate lines. Unix commands use backslashes () for line continuation. File upload commands should maintain platform-specific formatting just like other cURL commands in the codebase.
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/Get-Started/get-started-quickstart.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: 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-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: 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/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.
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-07-18T18:26:42.027Z
Learning: Applies to 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.
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 documentation Markdown and MDX files must begin with a frontmatter block including at least title and description fields.
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/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.
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: namastex888
PR: #9018
File: src/frontend/src/modals/apiModal/utils/get-curl-code.tsx:139-184
Timestamp: 2025-07-11T21:32:57.160Z
Learning: In TypeScript/JavaScript cURL code generation for Langflow, PowerShell commands must use backticks () for line continuation and follow the pattern: curl --request POST ` followed by --url, --header flags on separate lines. Unix commands use backslashes () for line continuation. File upload commands should maintain platform-specific formatting just like other cURL commands in the codebase.
docs/docs/Configuration/environment-variables.mdx (7)
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.
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: 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-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.
docs/docs/Configuration/configuration-authentication.mdx (7)
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.
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.
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-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.
🪛 LanguageTool
docs/docs/API-Reference/api-files.mdx
[style] ~275-~275: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...send it to the File component. To retrieve the File component's full ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~404-~404: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ed successfully" } ```
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 Gitleaks (8.27.2)
docs/docs/Configuration/configuration-authentication.mdx
104-104: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
⏰ 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 (97)
docs/docs/API-Reference/api-reference-api-examples.mdx (1)
139-150: Formatting tweak looks good.The added blank lines inside
<details>improve readability without altering content.docs/docs/API-Reference/api-flows-run.mdx (2)
43-45: Indentation cleanup approved.Aligning
<summary>with<details>is correct.
104-107: Consistent spacing approved.Extra newline after the fenced block prevents rendering glitches.
docs/docs/Components/components-data.mdx (1)
256-299: Indentation fix approved.The closing
</details>now matches its opener; renders correctly inside the ordered list.docs/docs/Concepts/data-types.mdx (1)
277-343: Tab markup update accepted.Removing
groupIdand adjusting indentation keeps functionality while simplifying markup.docs/docs/Concepts/concepts-publish.mdx (4)
172-172: LGTM! Tab indentation standardized.The indentation alignment for the
<TabItem>tags improves the consistency of the markup formatting across the documentation.
261-261: LGTM! Tab indentation standardized.The indentation alignment continues the consistent formatting improvements throughout the documentation.
333-333: LGTM! Tab indentation standardized.The formatting changes maintain consistency with the overall documentation structure improvements.
351-351: LGTM! Tab indentation standardized.The final tab formatting change completes the consistent markup alignment throughout this section.
docs/docs/Integrations/Google/integrations-google-big-query.mdx (2)
51-52: LGTM! Image indentation improved.The indentation of the image reference improves the visual hierarchy and formatting consistency within the numbered list structure.
55-82: LGTM! Tab-to-details conversion enhances readability.The replacement of the tabbed interface with a simple code block followed by a collapsible
<details>section provides better accessibility and aligns with the broader documentation standardization effort described in the PR objectives.docs/docs/Configuration/configuration-api-keys.mdx (7)
36-36: LGTM! Tab label formatting standardized.The removal of leading spaces from the
<TabItem>tag improves markup consistency.
43-44: LGTM! Tab formatting standardized.The consistent indentation alignment for tab components improves the overall documentation markup quality.
72-72: LGTM! Details element made open by default.Removing the
closedattribute makes the result section visible by default, which improves user experience by showing the expected output immediately.
96-97: LGTM! Tab formatting standardized.The consistent indentation alignment continues the formatting improvements throughout the file.
107-107: LGTM! Tab value simplified.The change from
"HTTP header"to"header"provides a cleaner, more concise tab identifier while maintaining clarity.
119-120: LGTM! Tab formatting and value simplified.The consistent formatting and simplified tab value from
"Query parameter"to"query"maintains the standardization improvements.
130-131: LGTM! Tab formatting standardized.The final tab formatting changes complete the consistent markup alignment throughout this section.
docs/docs/Integrations/Docling/integrations-docling.mdx (8)
52-55: LGTM! Component description improved with active voice.The rewritten description using active voice ("ingest documents, and then uses Docling to process them") is clearer and more direct. The explicit output specification improves user understanding.
56-56: LGTM! Parameter section formatting simplified.Converting from collapsible details to direct headings improves readability and accessibility of the parameter information.
66-69: LGTM! Component description improved with active voice.The consistent use of active voice and explicit output specification enhances clarity across all component descriptions.
70-70: LGTM! Parameter section formatting simplified.The consistent formatting approach improves the overall documentation structure.
83-86: LGTM! Component description improved with active voice.The active voice description and explicit DataFrame output specification maintains consistency with the other component improvements.
87-87: LGTM! Parameter section formatting simplified.The consistent parameter section formatting completes the structural improvements for this component.
101-104: LGTM! Component description improved with active voice.The final component description maintains the consistent active voice approach and clearly specifies the dual output options (Data or DataFrame).
105-114: LGTM! Parameter section formatting simplified.The consistent parameter section formatting and the preserved
doc_keyparameter complete the documentation improvements for this component.docs/docs/Configuration/environment-variables.mdx (12)
29-34: LGTM! Code block formatting improved.The proper enclosure of the bash code block with triple backticks and consistent indentation enhances readability and markup validity.
36-41: LGTM! Code block formatting standardized.The consistent formatting approach for the Windows code block maintains uniformity across all platform-specific instructions.
43-51: LGTM! Docker code block formatting improved.The proper code block formatting with consistent indentation improves the presentation of the Docker command example.
254-254: LGTM! Tab label case standardized.The change from ".env File" to ".env file" improves consistency with sentence case formatting standards mentioned in the coding guidelines.
412-412: LGTM! Tab value normalized.The change from "macOS" to lowercase "macos" provides consistency with tab value formatting conventions.
420-422: LGTM! Code block indentation standardized.The consistent indentation of the bash code block improves the visual hierarchy within the macOS instructions.
427-449: LGTM! XML code block and text indentation improved.The standardized indentation for both the explanatory text and the XML code block enhances readability and maintains consistent formatting throughout the macOS section.
453-456: LGTM! Final code block formatting standardized.The consistent indentation of the final bash command completes the formatting improvements for the macOS section.
458-458: LGTM! Tab value disambiguated.The change to "windows1" helps distinguish this tab from the PowerShell alternative, improving navigation clarity.
470-473: LGTM! Tip block indentation standardized.The consistent indentation of the tip block improves the visual hierarchy within the Windows System Properties instructions.
479-480: LGTM! Tab formatting standardized.The indentation alignment and tab value change to "windows2" complete the formatting improvements for the Windows section.
498-500: LGTM! Final tab formatting completed.The consistent indentation alignment concludes the comprehensive formatting improvements throughout this documentation file.
docs/docs/Concepts/concepts-overview.mdx (1)
25-25: Verify that the new anchor target exists
#flow-storage-and-logsreplaces the previous anchor. Please double-check that this exact ID is present in/concepts-flows; otherwise this link will break.docs/docs/Concepts/concepts-playground.mdx (1)
90-125: Indentation tidy-up looks goodThe adjusted
<TabItem>indentation does not alter semantics and improves readability. No further action needed.docs/docs/Deployment/deployment-kubernetes-prod.mdx (1)
114-135: Tab labels clarifiedRenaming the tabs to “values.yaml” and “Helm commands” matches the content and reads better. Looks good.
docs/docs/Tutorials/chat-with-files.mdx (1)
149-156: Consider moving prose outside the list itemLines 149-156 are indented as part of the ordered-list item 3., so the paragraph and
<details>block will render inside that list entry. If the intent is to show the result after the numbered steps, un-indent by four spaces so it is rendered as normal body text.docs/docs/Integrations/Arize/integrations-arize.mdx (1)
29-30: Tabvalueattributes should stay stableChanging
value="Arize Platform"→value="platform"andvalue="phoenix"is fine, but double-check any inbound links that programmatically select a tab via the hash (#platform)—those will now break.Also applies to: 52-54, 73-74
docs/docs/API-Reference/api-projects.mdx (1)
190-192: Great improvement: parameterised project IDReplacing the hard-coded UUID with
$PROJECT_IDmakes the example reusable—nice touch.docs/docs/Tutorials/chat-with-rag.mdx (2)
63-71: LGTM: Improved label clarity and accessibility.The updated tab labels "Langflow UI" and "Langflow API" are more descriptive and provide better context than the generic "UI" and "API" labels. This improves the user experience by making it immediately clear which specific Langflow interface is being referenced.
201-205: LGTM: Consistent terminology standardization.The change from "Response" to "Result" in the summary tag aligns with the broader documentation standardization effort across API reference files, providing consistency throughout the documentation.
docs/docs/API-Reference/api-build.mdx (3)
25-49: LGTM: Cleaner documentation structure with native HTML elements.The replacement of
<Tabs>and<TabItem>components with native<details>and<summary>elements provides a cleaner, more accessible approach to displaying collapsible example results. The consistent use of "Result" as the summary label improves standardization across the documentation.
60-74: LGTM: Consistent formatting improvements.The formatting of the streaming events endpoint example follows the same improved pattern, with proper
<details>structure and "Result" summary labeling.
142-149: LGTM: Uniform application of new formatting pattern.The override flow parameters example correctly applies the same
<details>and<summary>structure, maintaining consistency throughout the document.docs/docs/API-Reference/api-flows.mdx (4)
40-63: LGTM: Consistent implementation of native HTML collapsible sections.The replacement of tab-based UI components with
<details>and<summary>elements provides a more accessible and standardized approach to displaying API response examples. The "Result" summary label maintains consistency with the broader documentation update.
128-146: LGTM: Proper application of formatting standards.The "Read flow" endpoint example correctly follows the new formatting pattern with native HTML elements for collapsible content.
203-226: LGTM: Consistent formatting across all endpoints.All API endpoint examples in this file now follow the same improved formatting pattern, providing a unified user experience.
287-287: Minor improvement: Enhanced clarity in example description.The addition of "This example" at the beginning of line 287 provides better context for the file upload example, improving readability.
docs/docs/Concepts/mcp-server.mdx (3)
104-109: LGTM: Improved tab value and important user guidance.The change from "Auto install" to "auto" as the tab value provides better consistency, and the prominent note about local machine requirements is crucial for users to understand the limitations of auto installation.
115-117: LGTM: Clearer installation messaging.The updated text about configuration file installation is more precise and user-friendly.
255-297: LGTM: Improved JSON formatting consistency.The troubleshooting section's JSON examples now have consistent indentation and formatting, making them easier to read and copy. The maintained tab structure here is appropriate since this section provides alternative configuration options.
docs/docs/API-Reference/api-monitor.mdx (2)
22-385: LGTM: Comprehensive application of new formatting standards.The systematic replacement of
<Tabs>and<TabItem>components with<details>and<summary>elements across all API endpoint examples creates a consistent, accessible documentation experience. The "Result" summary labels provide clear identification of collapsible content.
473-473: LGTM: Enhanced example clarity.The addition of "previous
GET /messages" provides better context and helps users understand the relationship between the examples.docs/docs/Tutorials/agent.mdx (3)
78-139: LGTM! Consistent formatting and improved presentation.The code block indentation has been properly standardized, and the replacement of "Response" with "Result" in the summary aligns with the PR's objective to standardize labeling. The JavaScript code example is correctly formatted and the session ID naming improvement enhances clarity.
145-168: Excellent use of native HTML details element.The conversion from tabs to a native
<details>element with<summary>Result</summary>successfully achieves the PR's goal of replacing tab components with collapsible sections. This improves accessibility and maintains consistent presentation across the documentation.
171-171: Good clarification on session naming.The change from "New sessions are named after the user's email address" to "New sessions are named after the user's email address" provides better clarity about the session naming convention.
docs/docs/API-Reference/api-files.mdx (12)
33-58: Improved variable placeholder formatting and consistent details structure.The change from
<YOUR-FLOW-ID>to$FLOW_IDfollows standard shell variable conventions, and the replacement of tabs with<details>elements achieves the PR's objective of standardizing collapsible content presentation.
124-134: Consistent application of details pattern.The conversion to
<details><summary>Result</summary>maintains the same collapsible functionality while using native HTML elements for better consistency across the documentation.
147-155: Proper implementation of collapsible results.The standardized use of
<summary>Result</summary>aligns with the PR's goal of consistent labeling for response/result/output code blocks.
167-177: Consistent formatting applied throughout.The pattern continues to be applied consistently, improving documentation uniformity.
191-208: Well-structured multi-step process with consistent formatting.The numbered list formatting and use of
<details>for the/whoamiresponse maintains clarity while following the established pattern for collapsible content.
209-232: Clear instructions with proper code formatting.The indentation and formatting improvements enhance readability, and the ampersand (
@) instruction is important for curl file uploads.
248-304: Comprehensive file upload workflow with consistent presentation.The multi-step process is well-structured with proper indentation, and the collapsible result section maintains the standardized format established throughout the PR.
316-332: Consistent details implementation continues.The pattern is applied uniformly across all API endpoint examples.
347-355: Standardized result presentation.The consistent use of
<summary>Result</summary>maintains the pattern established throughout the documentation update.
367-381: Proper formatting maintained.The collapsible section formatting is consistent with the rest of the file.
393-403: Final consistent implementation.The pattern is completed consistently throughout the file.
415-425: Complete standardization achieved.The final section maintains the same consistent formatting and presentation style.
docs/docs/Agents/agents-tools.mdx (3)
49-49: Good addition of hyperlink to custom components documentation.The link to
/components-custom-componentsprovides helpful context and follows best practices for cross-referencing related documentation.
53-114: Excellent improvement in code example presentation.The conversion to a collapsible
<details>section with "Text Analyzer custom component" as the summary title makes the code example more discoverable while keeping the documentation clean. The introductory sentence provides good context for the code snippet.
120-135: Improved clarity in example result presentation.The change from "The agent correctly calls" to "Based on your instruction, the agent should call" provides better guidance on expected behavior, and the conversion to a plain code block with descriptive text is cleaner than the previous collapsible format.
docs/docs/Get-Started/get-started-quickstart.mdx (5)
15-17: Improved list formatting for prerequisites.Converting checklist items to plain text links makes the prerequisites section cleaner and more readable.
18-48: Well-structured collapsible API key creation guide.The
<details>section for creating a Langflow API key is properly indented and formatted, making it easy to follow while keeping the main quickstart flow uncluttered. The code example is correctly formatted with proper indentation.
103-182: Consistent tab formatting improvements.The removal of
groupIdattributes and proper indentation of<TabItem>elements enhances consistency. The tab structure remains functional while being cleaner.
190-358: Standardized result presentation with details element.The conversion from tabs to
<details><summary>Result</summary>achieves the PR's main objective of standardizing collapsible content presentation. The extensive JSON response example is now properly contained within the details element.
369-515: Consistent tab formatting maintained.The tab structure for Python and JavaScript examples maintains proper indentation and formatting consistency throughout the complex code examples.
docs/docs/Configuration/configuration-authentication.mdx (5)
73-99: Improved tab labeling and formatting consistency.The change from "macOS/Linux" to "Linux or macOS" provides clearer labeling, and the tab value change from "unix" to "linux-macos" is more descriptive. The consistent indentation and spacing improve readability.
102-105: Proper code block indentation.The
.envfile example is now properly indented for better visual structure.
138-175: Consistent formatting applied to duplicate section.The same improvements from the earlier section are consistently applied here, maintaining uniformity throughout the document.
172-174: Better command formatting.The Langflow startup command is now properly indented for improved readability.
181-201: Enhanced user credential presentation.The conversion to a bulleted list format for superuser credentials makes the information clearer and more scannable. The explicit mention of default values is helpful.
docs/docs/Get-Started/get-started-installation.mdx (2)
26-49: LGTM! Clean and consistent tab structure.The removal of
groupIdand standardization of the macOS tab value to lowercase"macos"improves consistency across the documentation.
86-157: LGTM! Excellent improvement in virtual environment guidance.The replacement of tabs with a native
<details>element provides a much cleaner and more accessible presentation. The expanded content includes comprehensive step-by-step instructions with clear explanations of environment variable modifications and best practices. The structure is well-organized with proper formatting and helpful context about deactivation and deletion commands.docs/docs/Contributing/contributing-how-to-contribute.mdx (4)
42-43: LGTM! Improved clarity for running from source.The addition clarifies that users can run Langflow from source even without contributing, which is helpful context.
44-118: LGTM! Excellent restructuring of OS-specific instructions.The replacement of tabs with
<details>elements provides a cleaner, more accessible format. The separation into three distinct sections (macOS/Linux, Windows CMD, and PowerShell) with clear step-by-step instructions greatly improves usability. The inclusion of both script-based and manual command approaches gives users flexibility in their setup process.
122-191: LGTM! Simplified and improved development environment setup.The restructured tab format with clearer step numbering and better explanations makes the development setup process much more accessible. The addition of context about automatic dependency installation and the expanded pre-commit hooks section provides valuable guidance for contributors.
208-252: LGTM! Comprehensive documentation contribution guidance.The expanded step-by-step instructions for documentation contributions are much clearer and more actionable. The numbered format, explicit commands, and detailed explanations about file structure, navigation, and local builds provide excellent guidance for new contributors.
docs/docs/Develop/Clients/typescript-client.mdx (5)
19-41: LGTM! Clean tab structure for package managers.The removal of the
groupIdattribute maintains consistency with the documentation-wide formatting standardization while preserving the clear package manager options.
47-62: LGTM! Improved code formatting and clarity.The reformatted code blocks with proper TypeScript syntax highlighting and the enhanced explanatory text improve readability and provide better guidance for users.
65-120: LGTM! Excellent enhancement of the quickstart section.The restructured quickstart with numbered steps, improved code examples, and comprehensive explanation of the response structure greatly enhances the user experience. The addition of the
chatOutputText()convenience method and JSON stringification options provides practical guidance for different use cases.
127-264: LGTM! Well-structured advanced features with comprehensive streaming example.The reorganized advanced features section with clear separation of tweaks and session ID concepts, followed by a detailed streaming example with comprehensive result documentation, provides excellent guidance for advanced usage patterns. The
<details>element with the streaming response example maintains consistency with the documentation-wide formatting improvements.
268-380: LGTM! Comprehensive logs retrieval documentation.The enhanced logs section with a complete working example script, clear setup instructions, and detailed result documentation provides excellent guidance for users wanting to monitor flow execution. The truncated example output with explanatory context helps users understand what to expect.
| ```shell | ||
| curl -X POST \ | ||
| "$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \ | ||
| -H "accept: application/json" \ | ||
| -H "Content-Type: application/json" \ | ||
| -H "x-api-key: $LANGFLOW_API_KEY" \ | ||
| -d '{ | ||
| "inputs": { | ||
| "input_value": "Tell me a story" | ||
| } | ||
| }' | ||
| ``` |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify shell syntax consistency across codebase.
The code blocks now use shell instead of bash as the language identifier. Ensure this change is consistent across all documentation files.
🏁 Script executed:
#!/bin/bash
# Description: Check for inconsistent shell language identifiers in documentation
# Find all shell code blocks and check for consistency
rg -n '```(bash|shell|sh)' docs/Length of output: 11814
Ensure consistent shell code block identifiers across documentation
Several docs still use bash or sh code fences. Please replace all of them with shell to match the updated convention.
• Replace every instance of bash and sh in the docs/ folder with ```shell.
• Example diff:
- ```bash
+ ```shell• You can bulk-apply this with:
rg -l '```bash|```sh' docs/ | xargs sed -i 's/^```\(bash\|sh\)/```shell/'🤖 Prompt for AI Agents
In docs/docs/API-Reference/api-build.mdx around lines 27 to 38, the shell code
block uses ```bash or ```sh instead of the updated convention ```shell. To fix
this, replace all occurrences of ```bash and ```sh code fences in the docs/
folder with ```shell to ensure consistency. You can do this manually or
bulk-apply using the provided command to update all relevant code blocks.
|
|
||
|
|
||
| For information about other environment variables and their usage, see [Environment Variables](/environment-variables). | ||
| For information about other environment variables and their usage, see [Environment Variables](/environment-variables). |
There was a problem hiding this comment.
Broken internal link casing
/environment-variables does not exist; the file lives at /configuration-environment-variables. Update the link or add a redirect, otherwise the reference will 404.
-For information about other environment variables and their usage, see [Environment Variables](/environment-variables).
+For information about other environment variables and their usage, see [Environment variables](/configuration-environment-variables).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| For information about other environment variables and their usage, see [Environment Variables](/environment-variables). | |
| For information about other environment variables and their usage, see [Environment variables](/configuration-environment-variables). |
🤖 Prompt for AI Agents
In docs/docs/Configuration/configuration-global-variables.mdx at line 202, the
internal link points to /environment-variables which does not exist. Update the
link to the correct path /configuration-environment-variables to prevent a 404
error.
github-actions
bot
added
documentation
|
Build successful! ✅ |
SonicDMG
temporarily deployed
to
lfoss-1508 - langflow-manual-install PR #9196
Render
Destroyed
github-actions
bot
added
documentation
|
|
Build successful! ✅ |
* audit details * tabs pt 1 * tabs pt 2 * tabs pt 3 * tabs to details
Tabsand<details>in the docs for consistent usage, nesting, and labeling.detailsresult.<summary>Result</summary>consistently for all response/result/output codeblocks inside<details>.Summary by CodeRabbit