docs: combine api keys and authentication pages #9172
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 consolidates and restructures Langflow's documentation on API keys and authentication. It removes the separate configuration pages for authentication and API keys, replacing them with a unified and expanded "API keys and authentication" guide. All internal documentation links are updated to reference the new page, and sidebar and redirect configurations are adjusted accordingly. No code or functional logic is changed. Changes
Sequence Diagram(s)No sequence diagram generated as all changes are documentation and configuration updates without new or modified control flow. 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
the
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: 1
🧹 Nitpick comments (11)
src/frontend/tests/core/features/filterSidebar.spec.ts (1)
5-8: Polish the test name for clarity
"user must see on handle click the possibility connections"is difficult to parse.
Consider rephrasing to something like:test( "clicking the left URL handle shows all available connection options in the sidebar", { tag: ["@release", "@components", "@api"] }, … );A clear, imperative description makes failures easier to triage in CI dashboards.
docs/docs/Develop/Clients/typescript-client.mdx (1)
54-57: Align link text with new page title for consistencyThe target page is now titled “API keys and authentication”. Consider reflecting the full title in the link text so that users immediately recognize they’re being taken to a combined guide.
-To create an API key, see [API keys](/api-keys-and-authentication). +To create an API key, see [API keys and authentication](/api-keys-and-authentication).docs/docs/Configuration/configuration-cli.mdx (1)
39-42: Minor wording tweak to mirror destination page titleUse the exact title of the consolidated page for clearer cross-reference.
-For more information, see [API keys](/api-keys-and-authentication). +For more information, see [API keys and authentication](/api-keys-and-authentication).docs/docs/Tutorials/chat-with-files.mdx (1)
18-21: Sync link label with new combined guideReplicate the full page title wherever it’s referenced.
-- [A Langflow API key](/api-keys-and-authentication) +- [A Langflow API key](/api-keys-and-authentication) <!-- keep list style unchanged -->and
-* `LANGFLOW_API_KEY`: A valid Langflow API key. To create an API key, see [API keys](/api-keys-and-authentication). +* `LANGFLOW_API_KEY`: A valid Langflow API key. To create an API key, see [API keys and authentication](/api-keys-and-authentication).Also applies to: 80-83
docs/docs/Support/release-notes.mdx (1)
55-58: Keep release-note references explicitUsing the full document title makes the link self-describing and avoids confusion with older, now-removed pages.
-For more information, see [API keys](/api-keys-and-authentication). +For more information, see [API keys and authentication](/api-keys-and-authentication).docs/docs/Concepts/concepts-file-management.mdx (1)
21-22: Remove duplicated word “page”The sentence currently reads “…[Projects page] … page…”, resulting in a redundant second page.
- * In the Langflow UI, on the [**Projects** page](/concepts-flows#projects) page, click **My Files** below the list of projects. + * In the Langflow UI, on the [**Projects** page](/concepts-flows#projects), click **My Files** below the list of projects.docs/docs/API-Reference/api-reference-api-examples.mdx (2)
65-67: Link text should match the destination titleThe destination page is titled “API keys and authentication” but the anchor text only says “API keys”. Aligning the wording avoids implying that authentication details are elsewhere.
-For more information, see [API keys](/api-keys-and-authentication). +For more information, see [API keys and authentication](/api-keys-and-authentication).
118-121: Same wording issue as above-Commonly used values in Langflow API requests include your [Langflow server URL](#base-url), [Langflow API keys](/api-keys-and-authentication), flow IDs, and [project IDs](/api-projects#read-projects). +Commonly used values in Langflow API requests include your [Langflow server URL](#base-url), [Langflow API keys and authentication](/api-keys-and-authentication), flow IDs, and [project IDs](/api-projects#read-projects).docs/docs/Concepts/concepts-publish.mdx (1)
64-64: Updated reference – minor style nitConsider capitalising the whole title for visual consistency, e.g. “See API Keys and Authentication”.
docs/docs/Configuration/api-keys-and-authentication.mdx (2)
53-55: Environment-variable name formatting is inconsistent
AUTO LOGIN(with a space) deviates from the rest of the document’sLANGFLOW_AUTO_LOGIN/AUTO_LOGINspelling and may confuse users copying the text verbatim. Use the exact variable name everywhere for consistency.
27-32: Minor style repetitionThree consecutive sentences start with “In Langflow …”. Rephrase one to improve flow and match the style-guide guidance flagged by LanguageTool.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (24)
SECURITY.md(1 hunks)docs/docs/API-Reference/api-reference-api-examples.mdx(2 hunks)docs/docs/Agents/agents.mdx(1 hunks)docs/docs/Concepts/concepts-file-management.mdx(1 hunks)docs/docs/Concepts/concepts-overview.mdx(2 hunks)docs/docs/Concepts/concepts-publish.mdx(2 hunks)docs/docs/Concepts/mcp-server.mdx(2 hunks)docs/docs/Configuration/api-keys-and-authentication.mdx(1 hunks)docs/docs/Configuration/configuration-api-keys.mdx(0 hunks)docs/docs/Configuration/configuration-authentication.mdx(0 hunks)docs/docs/Configuration/configuration-cli.mdx(1 hunks)docs/docs/Configuration/environment-variables.mdx(1 hunks)docs/docs/Develop/Clients/typescript-client.mdx(1 hunks)docs/docs/Develop/develop-application.mdx(1 hunks)docs/docs/Develop/memory.mdx(1 hunks)docs/docs/Get-Started/get-started-quickstart.mdx(2 hunks)docs/docs/Support/release-notes.mdx(1 hunks)docs/docs/Tutorials/agent.mdx(2 hunks)docs/docs/Tutorials/chat-with-files.mdx(2 hunks)docs/docs/Tutorials/chat-with-rag.mdx(2 hunks)docs/docs/Tutorials/mcp-tutorial.mdx(2 hunks)docs/docusaurus.config.js(1 hunks)docs/sidebars.js(2 hunks)src/frontend/tests/core/features/filterSidebar.spec.ts(1 hunks)
💤 Files with no reviewable changes (2)
- docs/docs/Configuration/configuration-api-keys.mdx
- docs/docs/Configuration/configuration-authentication.mdx
🧰 Additional context used
📓 Path-based instructions (4)
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/Configuration/configuration-cli.mdxdocs/docs/Concepts/concepts-file-management.mdxdocs/docs/Develop/Clients/typescript-client.mdxdocs/docs/Get-Started/get-started-quickstart.mdxdocs/docs/Agents/agents.mdxdocs/docs/Support/release-notes.mdxdocs/docs/Tutorials/chat-with-files.mdxdocs/docs/Develop/memory.mdxdocs/docs/Develop/develop-application.mdxdocs/docs/Tutorials/chat-with-rag.mdxdocs/docs/Tutorials/mcp-tutorial.mdxdocs/docs/Concepts/concepts-overview.mdxdocs/docs/Concepts/concepts-publish.mdxdocs/docs/Concepts/mcp-server.mdxdocs/docs/API-Reference/api-reference-api-examples.mdxdocs/docs/Tutorials/agent.mdxdocs/docs/Configuration/api-keys-and-authentication.mdxdocs/docs/Configuration/environment-variables.mdx
docs/docusaurus.config.js
📄 CodeRabbit Inference Engine (.cursor/rules/docs_development.mdc)
Site configuration such as title, tagline, URL, and navbar items must be managed in docs/docusaurus.config.js.
Files:
docs/docusaurus.config.js
docs/sidebars.js
📄 CodeRabbit Inference Engine (.cursor/rules/docs_development.mdc)
Sidebar navigation must be updated in docs/sidebars.js to reflect new or reorganized documentation content.
Files:
docs/sidebars.js
src/frontend/**/*.@(test|spec).{ts,tsx,js,jsx}
📄 CodeRabbit Inference Engine (.cursor/rules/testing.mdc)
src/frontend/**/*.@(test|spec).{ts,tsx,js,jsx}: Frontend test files should be located in 'src/frontend/' and use '.test.{ts,tsx,js,jsx}' or '.spec.{ts,tsx,js,jsx}' extensions.
Test both sync and async code paths in frontend test files.
Mock external dependencies appropriately in frontend test files to isolate unit tests from external services.
Test error handling and edge cases in frontend test files.
Validate input/output behavior and test component initialization and configuration in frontend test files.
Each frontend test should have a clear description or comment explaining its purpose, especially for complex setups or mocks.
Files:
src/frontend/tests/core/features/filterSidebar.spec.ts
🧠 Learnings (23)
📓 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.
docs/docs/Configuration/configuration-cli.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: 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 (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/**/*.{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.
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/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: 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
docs/docs/Develop/Clients/typescript-client.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: 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-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-quickstart.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/**/*.{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/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} : 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: 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/Agents/agents.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: 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: 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/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).
docs/docs/Support/release-notes.mdx (3)
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-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} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.
docs/docs/Tutorials/chat-with-files.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: 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/Develop/memory.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.
SECURITY.md (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/**/*.{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: 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/Develop/develop-application.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: 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/Tutorials/chat-with-rag.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/**/*.{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: 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-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/docusaurus.config.js (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/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} : 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/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.
docs/docs/Tutorials/mcp-tutorial.mdx (2)
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/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/sidebars.js (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-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: Sidebar and navigation should be kept current to ensure users can easily find all documentation sections and cross-references.
docs/docs/Concepts/concepts-overview.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-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-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.
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/Concepts/concepts-publish.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/**/*.{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/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: 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-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/mcp-server.mdx (2)
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.
docs/docs/API-Reference/api-reference-api-examples.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/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} : Internal links in documentation must be functional and not broken.
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-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.
src/frontend/tests/core/features/filterSidebar.spec.ts (8)
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/frontend/**/*.@(test|spec).{ts,tsx,js,jsx} : Each frontend test should have a clear description or comment explaining its purpose, especially for complex setups or mocks.
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/frontend/**/*.@(test|spec).{ts,tsx,js,jsx} : Test error handling and edge cases in frontend test files.
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/frontend/**/*.@(test|spec).{ts,tsx,js,jsx} : Test both sync and async code paths in frontend test files.
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/frontend/**/*.@(test|spec).{ts,tsx,js,jsx} : Validate input/output behavior and test component initialization and configuration in frontend test files.
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/frontend/**/*.@(test|spec).{ts,tsx,js,jsx} : Frontend test files should be located in 'src/frontend/' and use '.test.{ts,tsx,js,jsx}' or '.spec.{ts,tsx,js,jsx}' extensions.
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/frontend_development.mdc:0-0
Timestamp: 2025-07-18T18:27:12.609Z
Learning: Applies to src/frontend/src//tests//*.{ts,tsx,js,jsx} : All frontend code should be tested using appropriate component and integration tests.
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/frontend/**/*.@(test|spec).{ts,tsx,js,jsx} : Mock external dependencies appropriately in frontend test files to isolate unit tests from external services.
docs/docs/Tutorials/agent.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/**/*.{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: 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-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/Configuration/api-keys-and-authentication.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/Configuration/environment-variables.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/**/*.{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.
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.
🪛 LanguageTool
docs/docs/Configuration/api-keys-and-authentication.mdx
[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ests don't require a Langflow API key. In Langflow version 1.5, you can set `LANG...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~190-~190: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ests don't require a Langflow API key. In Langflow version 1.5, you can set `LANG...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ 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 (19)
src/frontend/tests/core/features/filterSidebar.spec.ts (1)
76-78: Readability improvement looks goodThe split into multiple lines makes the long test-ID easier to spot in reviews and merge conflicts.
No functional change introduced—assertion remains intact.docs/docs/Agents/agents.mdx (1)
116-119: Verify anchor fragment on the new consolidated pageThe fragment
#add-component-api-keys-to-langflowwas kept from the old URL.
Please confirm that this exact heading ID exists inapi-keys-and-authentication.mdx; otherwise the link will break.docs/docs/Get-Started/get-started-quickstart.mdx (2)
16-17: Link update looks goodThe reference was correctly redirected to the new consolidated page.
558-559: Consistent link update confirmedThe Credential management list item now targets the unified guide—no further action needed.
docs/docs/Develop/develop-application.mdx (1)
78-79: Verify anchor exists in the new consolidated docThe link targets
#authentication-configuration-valueson/api-keys-and-authentication. Double-check that this exact anchor id is defined; otherwise readers will land at the top of the page.SECURITY.md (1)
60-62: Updated security-doc link acknowledgedRedirect to the unified guide is correct.
docs/docs/Tutorials/agent.mdx (1)
17-17: Approve link update – target page exists and is included in sidebarThe
api-keys-and-authentication.mdxfile was found atdocs/docs/Configuration/api-keys-and-authentication.mdxand is referenced indocs/sidebars.js. The links on lines 17 and 72 ofdocs/docs/Tutorials/agent.mdxnow correctly point to the consolidated page.docs/docs/Configuration/environment-variables.mdx (1)
188-188: Description link updated – check anchor accuracy
/api-keys-and-authentication#authentication-configuration-valueslooks correct, but anchors sometimes drift after page refactors. Please open the new page once and confirm that the#authentication-configuration-valuesfragment still resolves.docs/docs/Tutorials/chat-with-rag.mdx (1)
15-15: Consistent link migrations – LGTMBoth occurrences now target the unified page. No further issues spotted.
Also applies to: 135-135
docs/docs/Tutorials/mcp-tutorial.mdx (1)
29-29: Links migrated – verify page availabilitySame comment as above: link looks right, just ensure the page renders and no redirect loop occurs.
Also applies to: 219-219
docs/docs/Concepts/concepts-overview.mdx (2)
25-25: LGTM: Anchor link correctly updated.The anchor reference has been updated to match the renamed section in the target page.
77-77: LGTM: Link properly updated to consolidated documentation.The link has been correctly updated from the old separate API keys page to the new unified authentication and API keys page, using the proper absolute path format.
docs/docusaurus.config.js (1)
259-266: LGTM: Redirect configuration properly updated for documentation consolidation.The redirect configuration correctly:
- Updates the target to the new unified page (
/api-keys-and-authentication)- Includes both old paths (
/configuration-api-keysand/configuration-authentication) in the source array- Maintains existing security best practices redirects
- Ensures backward compatibility for all existing links
docs/docs/Develop/memory.mdx (2)
29-29: LGTM: User table documentation link properly updated.The link now points to the consolidated authentication documentation with a specific anchor for authentication configuration values, providing more targeted guidance.
37-37: LGTM: ApiKey table documentation link correctly updated.The link has been properly updated to reference the new consolidated API keys and authentication page.
docs/docs/Concepts/mcp-server.mdx (2)
145-147: LGTM: Authentication requirement links properly updated.The authentication-related links in the important note have been correctly updated to point to the new consolidated documentation page.
161-161: LGTM: Authentication section links correctly consolidated.Both the authentication and API keys links now properly point to the unified documentation page, maintaining logical consistency since both topics are now covered in the same document.
docs/sidebars.js (1)
113-114: LGTM: Sidebar properly updated to reflect documentation consolidation.The sidebar configuration correctly:
- Replaces the two separate entries for API keys and authentication with a single consolidated entry
- Points to the new unified documentation page
- Maintains logical ordering within the "Develop" category
- Follows the coding guideline requirement to update sidebar navigation for reorganized content
docs/docs/Configuration/api-keys-and-authentication.mdx (1)
49-50: Flag syntax may be incorrect (--backend-only=true)The Langflow CLI flag is usually
--backend-only(boolean) rather than a key/value pair. Please double-check the accepted syntax to avoid confusing readers.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
github-actions
bot
added
documentation
This comment was marked as outdated.
This comment was marked as outdated.
github-actions
bot
added
documentation
|
Build successful! ✅ |
aimurphy
left a comment
aimurphy
left a comment
There was a problem hiding this comment.
Thanks for combining the pages. I left a bunch of questions and some suggestions to add more information. There are a few concepts that aren't clear to me.
Co-authored-by: April I. Murphy <[email protected]>
github-actions
bot
added
documentation
|
Build successful! ✅ |
github-actions
bot
added
documentation
|
Build successful! ✅ |
github-actions
bot
added
documentation
|
Build successful! ✅ |
github-actions
bot
added
documentation
|
Build successful! ✅ |
github-actions
bot
added
documentation
|
Build successful! ✅ |
SonicDMG
temporarily deployed
to
docs-lfoss-1565 - langflow-manual-install PR #9172
Render
Destroyed
github-actions
bot
added
documentation
|
|
Build successful! ✅ |
* combine-api-keys-and-auth * remove-old-page-redirect-and-sidebar * Update docs/docs/Configuration/api-keys-and-authentication.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * fix-parse-error * Apply suggestions from code review Co-authored-by: April I. Murphy <[email protected]> * upto-env-vars * clarity-in-example * clarify-user-creation * specify-which-table * links * link text * environment variable alignment * environment variable table cleanup --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: April I. Murphy <[email protected]> Co-authored-by: April M <[email protected]>
3 participants
Summary by CodeRabbit
Documentation
Style