chore: post 1.6 docs cleanup#10022
Conversation
…langflow into docs-misc-29-sep-25
WalkthroughEdits standardize boolean/default formatting and admonition types across documentation, expand and reorder the Agents setup steps, add a PartialCurlyBraces snippet and links for template variables, tweak sidebar labels and Docusaurus sidebar behavior, and add an informational partial. No code or public API changes. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant E as Editor
participant A as Agent
participant P as Provider
participant T as Tools (News/URL/Calc)
U->>E: Open Agent flow
U->>E: Select Provider/Model
E->>P: Verify model availability
U->>E: Enter Credential for Provider
E->>P: Validate credential
U->>E: Add Chat Input/Output
U->>E: Add Tool-capable components
E->>T: Enable Tool Mode
T-->>A: Connect Toolset -> Tools
U->>A: Send prompt via Chat Input
A->>P: Invoke model
alt Tool invocation needed
A->>T: Call tool
T-->>A: Return tool result
end
A-->>U: Stream/return response via Chat Output
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (5 passed)
✨ 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. Comment |
|
|
Build successful! ✅ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (38)
docs/docs/Components/bundles-datastax.mdx (1)
1-4: Add required frontmatter description.Per docs guidelines, every MDX file must include a
descriptionin frontmatter. Please add a concise summary for SEO and previews.--- title: DataStax +description: Learn how to use Langflow’s DataStax bundle, including Astra DB, Graph RAG, HCD components, and tools for vector and hybrid search. slug: /bundles-datastax ---As per coding guidelines.
docs/docs/Components/components-io.mdx (2)
1-4: Add required description to frontmatterDocs must include at least title and description. Please add a concise description. [As per coding guidelines]
--- title: Input / Output slug: /components-io +description: Learn how Chat and Text Input/Output components work in Langflow, when to use each, and how to connect them in flows and via the API. ---
149-153: Minor: fix apostrophe in example requestTypo in sample input string.
- "input_value": "Whats the recommended way to install Docker on Mac M1", + "input_value": "What's the recommended way to install Docker on Mac M1?",docs/docs/Components/bundles-deepseek.mdx (1)
1-4: Add required frontmatter description.Docs must include at least title and description in frontmatter. Please add a concise description. As per coding guidelines.
--- title: DeepSeek slug: /bundles-deepseek +description: Learn how to use the DeepSeek bundle in Langflow to generate text and configure parameters like model, temperature, and JSON mode. ---docs/docs/Components/bundles-weaviate.mdx (1)
1-4: Add required frontmatter description.Docs must include title and description in frontmatter. Add a concise description for SEO and consistency.
--- title: Weaviate slug: /bundles-weaviate +description: Components for integrating Weaviate vector stores with Langflow. ---As per coding guidelines.
docs/docs/Concepts/concepts-playground.mdx (3)
1-4: Add required description to frontmatter.Per docs guidelines, each MDX file must include at least title and description in frontmatter. Add a concise description.
Apply this diff:
--- title: Test flows in the Playground +description: Learn how to run, debug, and share flows using the Langflow Playground, manage sessions, and review agent behavior. slug: /concepts-playground ---As per coding guidelines.
115-115: Fix pluralization."chat sessions" → "chat session".
Apply this diff:
-This command starts a new chat sessions with the specified `session_id` or it retrieves an existing session with that ID, if one exists. +This command starts a new chat session with the specified `session_id`, or retrieves an existing session with that ID if one exists.
145-145: Fix grammar in instruction.Add “to” after “want”.
Apply this diff:
-1. In Langflow, open the flow you want share. +1. In Langflow, open the flow you want to share.docs/docs/Integrations/Notion/notion-agent-meeting-notes.mdx (1)
1-4: Add required frontmatter description.Docs must include at least title and description. Add a concise 1–2 sentence description for search/SEO and to meet publishing rules.
--- title: Notion Meeting Notes Agent slug: /integrations/notion/notion-agent-meeting-notes +description: Learn how to build a Notion Meeting Notes Agent in Langflow that summarizes transcripts and creates or updates tasks and pages in your Notion workspace. ---As per coding guidelines.
docs/docs/Deployment/deployment-kubernetes-prod.mdx (2)
1-4: Add required frontmatter description.Per docs guidelines, description is mandatory.
Apply:
--- title: Deploy the Langflow production environment on Kubernetes +description: Install and run the Langflow Runtime on Kubernetes for production, including access, secrets, and scaling. slug: /deployment-kubernetes-prod ---
160-161: Kubernetes Secret wording is incorrect (not encrypted by default).Secrets are base64‑encoded; encryption at rest requires enabling a provider (e.g., KMS) and configuring etcd encryption.
Apply:
- The result is encrypted. + The value is base64-encoded in the Secret. Enable encryption at rest (for example, using a KMS provider) to encrypt Secrets in etcd.docs/docs/Components/bundles-exa.mdx (1)
1-4: Add required frontmatter description.Docs must include at least title and description in frontmatter. Add a concise description for SEO and consistency.
--- title: Exa slug: /bundles-exa +description: Exa bundle Components for Langflow that provide Exa Search tooling for Agents and MCP clients. ---As per coding guidelines.
docs/docs/Components/bundles-mongodb.mdx (1)
1-4: Add required frontmatter descriptionDocs must include at least title and description. Please add a concise, user-facing description.
Apply this minimal fix:
--- title: MongoDB slug: /bundles-mongodb +description: Components in the MongoDB bundle, including MongoDB Atlas vector search configuration and parameters. ---As per coding guidelines.
docs/docs/Concepts/concepts-publish.mdx (2)
1-4: Add required frontmatter description.Per docs guidelines, every page must include a description in frontmatter. Please add a concise 1–2 sentence summary.
Apply this diff:
--- title: Trigger flows with the Langflow API slug: /concepts-publish +description: Learn how to trigger Langflow Flows from external apps via the API, embed a chat widget, use MCP servers, and leverage the OpenAI Responses–compatible endpoint. ---As per coding guidelines.
354-383: Avoid exposing API keys in client code; add a security warning.Examples pass
api_keydirectly in browser code. That risks leaking credentials. Recommend adding a clear warning and suggesting a backend proxy or short‑lived tokens.Apply this insertion after the “Configure the langflow-chat web component” intro:
+:::danger Do not expose production API keys in the browser +Passing `api_key` in client‑side code makes the key publicly accessible. For production, route requests through a backend that injects credentials, or use short‑lived/scoped tokens. If you must use a client key, scope it to the minimal permissions and rotate it frequently. +:::Optionally, update React/Angular snippets to show reading a key from a secure server endpoint rather than a literal placeholder.
docs/docs/Configuration/api-keys-and-authentication.mdx (1)
1-4: Add required description to frontmatter.Docs must include at least title and description. Add a concise description for SEO and sidebar previews.
Apply:
--- title: API keys and authentication slug: /api-keys-and-authentication +description: Configure Langflow authentication, API keys, and security-related environment variables for the editor, CLI, and API. ---As per coding guidelines.
docs/docs/Agents/agents.mdx (1)
1-4: Add required description to frontmatter.Include a short description to meet docs frontmatter requirements.
--- title: Use Langflow agents slug: /agents +description: Build agentic flows in Langflow using the Agent component, tools, model providers, and best practices. ---As per coding guidelines.
docs/docs/Components/bundles-openrouter.mdx (1)
1-4: Add required frontmatter description.Docs must include at least title and description in frontmatter. Please add a concise description.
--- title: OpenRouter slug: /bundles-openrouter +description: Use OpenRouter bundle components in Langflow to generate text and language models via OpenRouter’s unified API. ---docs/docs/Components/bundles-vertexai.mdx (1)
1-4: Add required frontmatter description for docs complianceFrontmatter is missing a description. Our guidelines require at least title and description in every Markdown/MDX doc under docs/docs/.
Apply this diff:
--- title: Vertex AI +description: Configure and use Vertex AI components in Langflow for text generation and embeddings, including parameters and authentication setup. slug: /bundles-vertexai ---As per coding guidelines.
docs/docs/Concepts/concepts-components.mdx (2)
1-4: Add required frontmatter descriptionPlease include a description.
--- title: Components overview slug: /concepts-components +description: Learn how to add, configure, run, and manage Langflow Components, ports, versions, and grouping. ---
247-249: Grammar: “its” not “it's”Possessive pronoun needed.
- Multiple components can be grouped into a single component for reuse. This is useful for organizing large flows by combining related components together, such as a RAG **Agent** component and it's associated tools or vector store components. + Multiple components can be grouped into a single component for reuse. This is useful for organizing large flows by combining related components together, such as a RAG **Agent** component and its associated tools or vector store components.docs/docs/Components/components-processing.mdx (1)
1-4: Add required frontmatter descriptionPlease include a description.
--- title: Processing components slug: /components-processing +description: Learn how to transform and parse data in Langflow using Processing components like Parser, Data Operations, DataFrame Operations, and more. ---docs/docs/Components/components-helpers.mdx (1)
1-4: Add required frontmatter descriptionInclude a short description.
--- title: Helpers slug: /components-helpers +description: Explore Helper components that add utility functions to your flows, including Calculator, Current Date, and Message History. ---docs/docs/Get-Started/get-started-installation.mdx (1)
1-4: Add missing frontmatter and description fields to all docs/docs MDX files
- In docs/docs/Get-Started/get-started-installation.mdx, add:
--- title: Install Langflow slug: /get-started-installation +description: Install Langflow via Desktop, Docker, Python package, or from source on macOS, Windows, and Linux. ---- Several partial files in docs/docs/ lack any frontmatter—prepend each with at least:
Files needing frontmatter:--- title: <Your title here> description: <A one-line summary> ---
• _partial-agents-work.mdx
• _partial-conditional-params.mdx
• _partial-dev-mode-windows.mdx
• _partial-hidden-params.mdx
• _partial-legacy.mdx
• _partial-vector-rag-blurb.mdx
• _partial-vector-rag-flow.mdx
• _partial-vector-search-results.mdx
• _partial-vector-store-instance.mdx
• _partial-escape-curly-braces.mdxTo verify across all MDX files, you can run:
find docs/docs -name '*.mdx' -print0 \ | xargs -0 -n1 awk 'BEGIN{i=0} /^---/{i++; next} i==1{print} i>1{exit}' \ | grep -L '^description:' && echo "Some MDX files are missing descriptions"docs/docs/Components/components-prompts.mdx (1)
1-4: Add required frontmatter description.Docs must include at least title and description. Add a concise description summarizing the page.
--- title: Prompt Template slug: /components-prompts +description: Learn how to use the Prompt Template Component in Langflow, define variables with curly braces, and connect them to other Components in your Flow. ---As per coding guidelines.
docs/docs/Concepts/mcp-server.mdx (1)
1-4: Add required description to frontmatter.Frontmatter must include a description per docs guidelines. Please add a concise 1–2 sentence summary.
--- title: Use Langflow as an MCP server slug: /mcp-server +description: Learn how to expose Langflow flows as MCP tools, connect clients, configure auth, and manage server settings and environment variables. ---docs/docs/Components/bundles-amazon.mdx (1)
1-4: Add required description to frontmatter.--- title: Amazon slug: /bundles-amazon +description: Use Langflow’s Amazon bundle to connect Bedrock LLMs, embeddings, and S3 upload functionality with configurable parameters. ---docs/docs/Components/components-models.mdx (1)
1-4: Add required description to frontmatter.--- title: Language Model slug: /components-models +description: Learn how to use Langflow’s Language Model components, outputs, parameters, and how to connect additional providers and agents. ---docs/docs/Develop/memory.mdx (1)
1-4: Add required description to frontmatter.--- title: Memory management options slug: /memory +description: Configure Langflow’s storage, cache, and chat memory, including default paths, external databases, and environment variables. ---docs/docs/Components/bundles-azure.mdx (1)
1-4: Add required description to frontmatter.--- title: Azure slug: /bundles-azure +description: Connect Azure OpenAI models and embeddings in Langflow and configure parameters like endpoint, deployment, version, and streaming. ---docs/docs/Components/bundles-anthropic.mdx (1)
1-4: Add required frontmatter description.Docs pages must include a
descriptionin frontmatter. Add a concise summary.As per coding guidelines
--- title: Anthropic slug: /bundles-anthropic +description: Use Anthropic models in Langflow components for text generation and Language Model outputs. ---docs/docs/Develop/logging.mdx (1)
1-4: Add required frontmatter description.Please include a short
descriptionsummary.As per coding guidelines
--- title: Logs slug: /logging +description: Configure, locate, and view Langflow application and flow logs, including formats, environment variables, and Desktop logs. ---docs/docs/Components/bundles-xai.mdx (1)
1-4: Add required frontmatter description.Add a concise
descriptionto satisfy docs requirements.As per coding guidelines
--- title: xAI slug: /bundles-xai +description: Use xAI models like Grok in Langflow for text generation and Language Model outputs. ---docs/docs/Components/bundles-mistralai.mdx (1)
1-4: Add requireddescriptionto frontmatter.Docs guidelines require at least
titleanddescriptionin frontmatter.--- title: MistralAI slug: /bundles-mistralai +description: Components for generating text and embeddings with MistralAI models and configuration parameters. ---As per coding guidelines.
docs/docs/Components/bundles-chroma.mdx (1)
1-4: Add requireddescriptionto frontmatter.--- title: Chroma slug: /bundles-chroma +description: Use the Chroma DB component to read and write to Chroma vector stores, with parameters for caching, duplicates, and search. ---As per coding guidelines.
docs/docs/Components/components-custom-components.mdx (1)
1-4: Add requireddescriptionto frontmatter.--- title: Create custom Python components slug: /components-custom-components +description: Learn how to build custom Python Components for Langflow, define inputs and outputs, enable tool mode, and manage dynamic fields. ---As per coding guidelines.
docs/docs/Components/bundles-ibm.mdx (1)
1-4: Add requireddescriptionto frontmatter.--- title: IBM slug: /bundles-ibm +description: Components for IBM watsonx.ai text generation and embeddings, including parameters and usage notes. ---As per coding guidelines.
docs/docs/API-Reference/api-build.mdx (1)
1-4: Add requireddescriptionto frontmatter.--- title: Build endpoints slug: /api-build +description: Internal endpoints used by the Langflow visual editor to build flows and stream events; not for running flows in applications. ---As per coding guidelines.
🧹 Nitpick comments (54)
docs/docs/Components/bundles-deepseek.mdx (2)
9-22: Standardize capitalization of “Component(s)” per style guide.Capitalize Component consistently (and keep Product terms like Bundles as written). As per coding guidelines.
-<Icon name="Blocks" aria-hidden="true" /> [**Bundles**](/components-bundle-components) contain custom components that support specific third-party integrations with Langflow. +<Icon name="Blocks" aria-hidden="true" /> [**Bundles**](/components-bundle-components) contain custom Components that support specific third-party integrations with Langflow. -This page describes the components that are available in the **DeepSeek** bundle. +This page describes the Components that are available in the **DeepSeek** bundle. -The **DeepSeek** component generates text using DeepSeek's language models. +The **DeepSeek** Component generates text using DeepSeek's language models. -Use the **Language Model** output when you want to use a DeepSeek model as the LLM for another LLM-driven component, such as an **Agent** or **Smart Function** component. +Use the **Language Model** output when you want to use a DeepSeek model as the LLM for another LLM‑driven Component, such as an **Agent** or **Smart Function** Component.
33-33: LGTM on boolean literal formatting; minor clarity tweak optional.Current: “If
true, outputs JSON regardless of passing a schema.” Consider: “If set totrue, forces JSON output whether or not a schema is provided.” Up to you.docs/docs/Components/bundles-weaviate.mdx (2)
50-50: Standardize type to Boolean and capitalize “Component”.Ensure terminology and style consistency in the parameters table.
-| cache_vector_store | Cache Vector Store | Input parameter. If `true`, the component caches the vector store in memory for faster reads. Default: Enabled (`true`). | +| cache_vector_store | Boolean | Input parameter. If `true`, the Component caches the vector store in memory for faster reads. Default: Enabled (`true`). |As per coding guidelines.
53-53: Use second‑person voice for clarity.Minor tone tweak to match style guide.
-| search_by_text | Boolean | Input parameter. Indicates whether to search by text. Default: Disabled (`false`). | +| search_by_text | Boolean | Input parameter. Set to `true` to search by text. Default: Disabled (`false`). |As per coding guidelines.
docs/docs/Concepts/concepts-playground.mdx (1)
20-28: Optional style: capitalize “Component” when referring to Langflow UI entities.Guidelines call for capitalizing Component/Flow when used as product terms. Consider these small tweaks for consistency.
Examples:
-Then, if your flow has a [**Chat Input** component](/components-io)... +Then, if your flow has a [**Chat Input** Component](/components-io)... -...to the **Input** port of a **Language Model** or **Agent** component. +...to the **Input** port of a **Language Model** or **Agent** Component. -Click the component where you want to set a custom session ID. +Click the Component where you want to set a custom session ID.As per coding guidelines.
Also applies to: 85-96
docs/docs/Integrations/Notion/notion-agent-meeting-notes.mdx (3)
17-19: Admonition type change to warning looks good.Switching from non-standard “important” to built-in “warning” aligns with Docusaurus and our style guide. Consider linking to our secrets guidance to make the guidance actionable.
:::warning -Treat all keys and other credentials as sensitive information. Use secure references, and don't share them publicly. +Treat all keys and other credentials as sensitive information. Use secure references, and don't share them publicly. See the Secrets guide in Langflow for recommended practices. :::As per coding guidelines.
25-52: Adopt second‑person voice, sentence case headers, and capitalize Component/Flow consistently.Style guide prefers second person, sentence case headers, and capitalized “Component”/“Flow.” Minor edits improve clarity and consistency.
Examples (apply similarly across sections):
-### Meeting Transcript (text input) -This component allows users to input the meeting transcript directly into the flow. +### Meeting transcript (Text Input Component) +You paste the meeting transcript directly into the Flow using this Component. -### Notion components (tools) +### Notion Components (tools) -### Meeting Summarizer (Tool Calling Agent) +### Meeting summarizer (Tool Calling Agent) -Displays the final output of the Notion Agent in the Playground. +You see the final output of the Notion Agent in the Playground.As per coding guidelines.
Also applies to: 68-113, 129-153
141-142: Small UX copy tweak for consistency with UI terms.Match button label casing and action phrasing; keep present tense.
-4. Run the flow by clicking <Icon name="Play" aria-hidden="true" /> **Run component** on the **Chat Output** component or open the **Playground**. +4. Run the Flow by selecting <Icon name="Play" aria-hidden="true" /> **Run Component** on the **Chat Output** Component, or open the **Playground**.As per coding guidelines.
docs/docs/Deployment/deployment-kubernetes-prod.mdx (5)
11-17: Admonition type change is correct; consider link stability.Switching to :::warning matches allowed types. Also consider replacing the GitHub line anchor with a permalink (commit SHA) or removing the L46 anchor to avoid drift.
36-46: Empty groupId prop.
groupId=""is unnecessary; either remove it or set a meaningful id if you intend to sync tabs across the page.- <Tabs groupId=""> + <Tabs>
97-109: jq prerequisite.The example uses jq; add it to prerequisites for completeness.
- [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) - [Helm](https://helm.sh/docs/intro/install/) + - [jq](https://jqlang.github.io/jq/) (for command examples that parse JSON)
165-170: Release name inconsistency may confuse users.Earlier examples use
my-langflow-app/my-langflow-app-with-flow; here it’smy-langflow-app-image. Use one consistently.- helm upgrade my-langflow-app-image langflow/langflow-runtime -n langflow \ + helm upgrade my-langflow-app langflow/langflow-runtime -n langflow \
48-59: Capitalize “Flow” consistently.Style guide: always capitalize Flow/Flows when referring to the concept.
Examples:
- Install the chart and download flows from a URL + Install the chart and download Flows from a URL - A successful request returns a list of flows. + A successful request returns a list of Flows.If preferred, I can supply a patch covering all occurrences.
Also applies to: 77-79, 93-99, 111-119, 176-184, 205-208
docs/docs/Components/bundles-exa.mdx (2)
12-12: Use sentence case for headings.Style guide prefers sentence case headers.
-## Exa Search +## Exa search @@ -### Exa Search parameters +### Exa search parametersAs per coding guidelines.
Also applies to: 18-18
8-10: Capitalize “Component” when referring to Langflow entities.Maintain consistent terminology capitalization.
-<Icon name="Blocks" aria-hidden="true" /> [**Bundles**](/components-bundle-components) contain custom components that support specific third-party integrations with Langflow. +<Icon name="Blocks" aria-hidden="true" /> [**Bundles**](/components-bundle-components) contain custom Components that support specific third-party integrations with Langflow. @@ -This page describes the components that are available in the **Exa** bundle. +This page describes the Components that are available in the **Exa** bundle. @@ -This component provides an [Exa Search](https://exa.ai/) toolkit for search and content retrieval by a Langflow [**Agent** component](/agents) or [MCP client](/mcp-client). +This Component provides an [Exa Search](https://exa.ai/) toolkit for search and content retrieval by a Langflow [**Agent Component**](/agents) or [MCP client](/mcp-client).As per coding guidelines.
Also applies to: 14-15
docs/docs/Components/bundles-mongodb.mdx (2)
37-37: Style/terminology: capitalize “Component” and tighten link textKeep terminology consistent and align with sentence case.
-For information about accepted values and functionality, see the [MongoDB Atlas documentation](https://www.mongodb.com/docs/atlas/atlas-vector-search/tutorials/vector-search-quick-start/) or inspect [component code](/concepts-components#component-code). +For information about accepted values and functionality, see the [MongoDB Atlas documentation](https://www.mongodb.com/docs/atlas/atlas-vector-search/tutorials/vector-search-quick-start/) or inspect [Component code](/concepts-components#component-code).As per coding guidelines.
39-54: Good consistency fix on Boolean default; extend to other literals + minor grammarThe backticks for Default:
falselook good. For consistency with the style guide (“inline code with backticks for literals”), consider:
- Use backticks instead of quotes for option literals: append/overwrite, cosine/euclidean/dotProduct.
- Small grammar tweak for index_name.
-| index_name | String | Input parameter. The name of the Atlas Search index, it should be a Vector Search. Required. | +| index_name | String | Input parameter. The name of the Atlas Search index, which should be a Vector Search index. Required. | -| insert_mode | String | Input parameter. How to insert new documents into the collection. The options are "append" or "overwrite". Default: "append". | +| insert_mode | String | Input parameter. How to insert new documents into the collection. The options are `append` or `overwrite`. Default: `append`. | -| similarity | String | Input parameter. The method used to measure similarity between vectors. The options are "cosine", "euclidean", or "dotProduct". Default: "cosine". | +| similarity | String | Input parameter. The method used to measure similarity between vectors. The options are `cosine`, `euclidean`, or `dotProduct`. Default: `cosine`. |As per coding guidelines.
docs/docs/Concepts/concepts-publish.mdx (2)
145-146: Pin the embedded‑chat CDN version consistently.Examples mix
@mainand@v1.0.7. Using a moving target can break copy‑paste samples. Pin to the same tagged version used in the HTML example.Apply this diff:
- <script src="https://cdn.jsdelivr.net/gh/langflow-ai/langflow-embedded-chat@main/dist/build/static/js/bundle.min.js"></script> + <script src="https://cdn.jsdelivr.net/gh/langflow-ai/langflow-embedded-chat@v1.0.7/dist/build/static/js/bundle.min.js"></script> - script.src = 'https://cdn.jsdelivr.net/gh/langflow-ai/langflow-embedded-chat@main/dist/build/static/js/bundle.min.js'; + script.src = 'https://cdn.jsdelivr.net/gh/langflow-ai/langflow-embedded-chat@v1.0.7/dist/build/static/js/bundle.min.js';Optional: If there’s a newer stable tag, update all three occurrences together.
Also applies to: 214-216
178-201: Use accurate code‑fence languages (TS/TSX) for type‑safe examples.Blocks contain TypeScript and/or JSX but are fenced as
javascript. Adjust for correct syntax highlighting and linters.-```javascript +```tsx //Declaration of langflow-chat web component-```javascript +```tsx import React, { useEffect } from 'react';-```javascript +```ts import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';-```javascript +```ts import { Component } from '@angular/core';-```javascript +```ts import { Component } from '@angular/core';-```javascript +```ts import { Component } from '@angular/core';As per coding guidelines.
Also applies to: 206-245, 283-301, 306-331, 417-448, 491-517
docs/docs/Configuration/api-keys-and-authentication.mdx (3)
167-170: Backward-compat note looks good; consider explicit “temporary” window.LGTM. Optional: add “in 1.6 only” to make the deprecation timeline crisper.
292-296: Boolean formatting consistency.Table uses
Truewhich matches other env‑var examples. Consider standardizing all env‑var boolean examples in this page toTrue/Falsefor consistency (values are parsed as strings anyway).
131-141: Surface AWS requirement: some components need explicit in‑component credentials.To prevent confusion, add a short admonition noting that certain providers (e.g., AWS) require explicit credentials in the component and won’t fall back to machine creds in hosted environments.
For more information, see [Global variables](/configuration-global-variables). @@ You must delete or rotate component API keys directly using the service provider's interface or API. +:::warning +Some providers (for example, Amazon Web Services) require explicit credentials in the component configuration and do not fall back to environment or instance credentials in hosted environments. Ensure you supply `aws_access_key_id` and `aws_secret_access_key` in the component when using AWS‑backed Components. +::: + For added security, you can set `LANGFLOW_REMOVE_API_KEYS=True` to omit API keys and tokens from flow data in your [Langflow database](/memory).Based on learnings.
docs/docs/Agents/agents.mdx (2)
23-31: Model selection guidance: add a concrete example.Good clarity. Consider adding an example custom model name (e.g.,
gpt-5-mini) as noted in the PR objectives.If your preferred model isn't listed, type the complete model name into the **Model Name** field, and then select it from the **Model Name** menu. -Make sure that the model is enabled/verified in your model provider account. +For example, enter `gpt-5-mini` and select it. +Make sure that the model is enabled/verified in your model provider account.
95-100: “Connect other models” path is clear.Consider adding a cross‑link to any IBM gateway models doc added in this PR (if applicable) to help discovery.
docs/docs/Components/bundles-openrouter.mdx (1)
32-33: Removal of “(advanced)” looks good; tighten phrasing.Minor copy polish to clarify these are used for OpenRouter rankings.
-| site_url | String | Input parameter. Your site URL for OpenRouter rankings. | -| app_name | String | Input parameter. Your app name for OpenRouter rankings. | +| site_url | String | Input parameter. Your public site URL used by OpenRouter rankings. | +| app_name | String | Input parameter. Your app’s name used by OpenRouter rankings. |docs/docs/Components/bundles-vertexai.mdx (2)
35-43: Normalize default value formatting for consistencyUse inline code formatting for default literals to match the Embeddings table and broader docs style.
Apply this diff:
-| location | String | Input parameter. The location for the Vertex AI API. Default: "us-central1". | +| location | String | Input parameter. The location for the Vertex AI API. Default: `us-central1`. | -| max_output_tokens | Integer | Input parameter. The maximum number of tokens to generate. | +| max_output_tokens | Integer | Input parameter. The maximum number of tokens to generate. | -| max_retries | Integer | Input parameter. Maximum number of retries for API calls. Default: 1. | +| max_retries | Integer | Input parameter. Maximum number of retries for API calls. Default: `1`. | -| temperature | Float | Input parameter. Controls randomness in the output. Default: 0.0. | +| temperature | Float | Input parameter. Controls randomness in the output. Default: `0.0`. | | top_k | Integer | Input parameter. The number of highest-probability vocabulary tokens to keep for top-k-filtering. | -| top_p | Float | Input parameter. The cumulative probability of all highest-probability vocabulary tokens that are kept for nucleus sampling. Default: 0.95. | +| top_p | Float | Input parameter. The cumulative probability of all highest-probability vocabulary tokens that are kept for nucleus sampling. Default: `0.95`. | | verbose | Boolean | Input parameter. Whether to print verbose output. Default: `false`. |As per coding guidelines.
68-68: Avoid “chain” phrasing; clarify verbose behaviorThis component isn’t a chain; suggest neutral wording.
Apply this diff:
-| verbose | Boolean | Input parameter. This parameter controls the level of detail in the output. When set to `true`, it prints internal states of the chain to help debug. Default: `false`. | +| verbose | Boolean | Input parameter. Controls the level of detail in the output. When set to `true`, it prints additional debug information. Default: `false`. |As per coding guidelines.
docs/docs/Get-Started/get-started-installation.mdx (1)
153-154: PowerShell removal needs -Recurse -ForceRemove-Item on a directory requires recursion; add flags to avoid errors.
- To delete the virtual environment, type `Remove-Item VENV_NAME`. + To delete the virtual environment, type `Remove-Item -Recurse -Force VENV_NAME`.docs/docs/Components/components-processing.mdx (4)
78-79: Boolean literal casing: prefertrue/falsein UI docsStandardize to lowercase booleans for consistency across docs (unless explicitly referring to Python).
-| enable_metadata | BoolInput | Input parameter. If `True`, add metadata to the output DataFrame. | +| enable_metadata | BoolInput | Input parameter. If `true`, add metadata to the output DataFrame. |
674-679: Admonition title formattingConsider bracketed title syntax for consistency with Docusaurus admonitions.
- :::warning Overwrites allowed + :::warning[Overwrites allowed]
760-761: Boolean literal casing: prefertrue/falseAlign with the rest of the page.
-| keep_separator | Keep Separator | Input parameter. Select how to handle separators in output chunks. If `False`, separators are omitted from output chunks. Options include `False` (remove separators), `True` (keep separators in chunks without preference for placement), `Start` (place separators at the beginning of chunks), or `End` (place separators at the end of chunks). Default: `False`. | +| keep_separator | Keep Separator | Input parameter. Select how to handle separators in output chunks. If `false`, separators are omitted from output chunks. Options include `false` (remove separators), `true` (keep separators in chunks without preference for placement), `Start` (place separators at the beginning of chunks), or `End` (place separators at the end of chunks). Default: `false`. |
1142-1145: Boolean literal casing: prefertrue/falseStandardize casing in legacy section too.
-| remove_control_chars | Remove Control Characters | Input parameter. If set to `True`, this option removes control characters (ASCII characters 0-31 and 127) from the JSON string. This can help eliminate invisible characters that might cause parsing issues or make the JSON invalid. | +| remove_control_chars | Remove Control Characters | Input parameter. If set to `true`, this option removes control characters (ASCII characters 0-31 and 127) from the JSON string. This can help eliminate invisible characters that might cause parsing issues or make the JSON invalid. | ... -| validate_json | Validate JSON | Input parameter. If set to `True`, this option attempts to parse the JSON string to ensure it is well-formed before applying the final repair operation. It raises a ValueError if the JSON is invalid, allowing for early detection of major structural issues in the JSON. | +| validate_json | Validate JSON | Input parameter. If set to `true`, this option attempts to parse the JSON string to ensure it is well-formed before applying the final repair operation. It raises a ValueError if the JSON is invalid, allowing for early detection of major structural issues in the JSON. |docs/docs/Components/components-prompts.mdx (1)
37-66: Fix list numbering (missing step 3).Numbering jumps from 2 to 4. Prefer “1.” for all items so Docusaurus auto-numbers, avoiding future drift.
-1. Create a flow based on the **Basic prompting** template. +1. Create a flow based on the **Basic prompting** template. @@ -2. Click the **Prompt Template** component, and then add some variables to the **Template** field. +1. Click the **Prompt Template** component, and then add some variables to the **Template** field. @@ -4. Click **Check & Save** to save the template. +1. Click **Check & Save** to save the template. @@ -5. Provide input for the variable fields: +1. Provide input for the variable fields:As per coding guidelines (clarity).
docs/docs/Concepts/mcp-server.mdx (2)
286-288: Standardize boolean literals to backticked lowercasetrue/false.Elsewhere in this PR and docs, booleans are shown as
true/false. Here they’reTrue/Falseand the description mixes cases. Please align for consistency.-| `LANGFLOW_MCP_SERVER_ENABLED` | Boolean | `True` | Whether to initialize an MCP server for each of your Langflow projects. If `false`, Langflow doesn't initialize MCP servers. | -| `LANGFLOW_MCP_SERVER_ENABLE_PROGRESS_NOTIFICATIONS` | Boolean | `False` | If `true`, Langflow MCP servers send progress notifications. | +| `LANGFLOW_MCP_SERVER_ENABLED` | Boolean | `true` | Whether to initialize an MCP server for each of your Langflow projects. If `false`, Langflow doesn't initialize MCP servers. | +| `LANGFLOW_MCP_SERVER_ENABLE_PROGRESS_NOTIFICATIONS` | Boolean | `false` | If `true`, Langflow MCP servers send progress notifications. |
340-345: Prefer dynamic SSE URLs over hardcoded localhost in examples.Recommend referencing the UI‑generated JSON snippet or a placeholder like
SSE_URLinstead of a fixed localhost URL to avoid deployment confusion. Based on learnings.- http://localhost:7860/api/v1/mcp/project/d359cbd4-6fa2-4002-9d53-fa05c645319c/sse + SSE_URL_FROM_LANGFLOW_UI_JSON_SNIPPET + <!-- For example: http://LANGFLOW_SERVER_ADDRESS/api/v1/mcp/project/PROJECT_ID/sse -->docs/docs/Components/bundles-azure.mdx (1)
38-38: Tweak wording: “Defaults tofalse.”Match nearby rows (“Defaults to
0.7.”) and house style.-| Stream | Boolean | Input parameter. Specifies whether to stream the response from the model. Default to `false`. | +| Stream | Boolean | Input parameter. Specifies whether to stream the response from the model. Defaults to `false`. |docs/docs/Components/bundles-anthropic.mdx (1)
36-37: Tighten default phrasing to match table style.Use “Default:
….” for consistency with other rows.-| anthropic_api_url | String | Input parameter. Endpoint of the Anthropic API. Defaults to `https://api.anthropic.com` if not specified. | +| anthropic_api_url | String | Input parameter. Endpoint of the Anthropic API. Default: `https://api.anthropic.com`. |docs/docs/Develop/logging.mdx (1)
41-46: Standardize boolean casing totrue/false.Use lowercase booleans in code font for defaults and references.
Based on learnings
-| `LANGFLOW_PRETTY_LOGS` | Boolean | `True` | This variable controls log output format when `LANGFLOW_LOG_ENV=default` or unset. When `true`, uses structlog's [ConsoleRenderer](https://www.structlog.org/en/stable/console-output.html). When `false`, outputs logs in JSON format. | +| `LANGFLOW_PRETTY_LOGS` | Boolean | `true` | This variable controls log output format when `LANGFLOW_LOG_ENV=default` or unset. When `true`, uses structlog's [ConsoleRenderer](https://www.structlog.org/en/stable/console-output.html). When `false`, outputs logs in JSON format. | @@ -| `LANGFLOW_ENABLE_LOG_RETRIEVAL` | Boolean | `False` | Enables retrieval of logs from your Langflow instance with [Logs endpoints](/api-logs). | +| `LANGFLOW_ENABLE_LOG_RETRIEVAL` | Boolean | `false` | Enables retrieval of logs from your Langflow instance with [Logs endpoints](/api-logs). | -| `LANGFLOW_LOG_RETRIEVER_BUFFER_SIZE` | Integer | `10000` | Set the buffer size for log retrieval if `LANGFLOW_ENABLE_LOG_RETRIEVAL=True`. Must be greater than `0` for log retrieval to function. | +| `LANGFLOW_LOG_RETRIEVER_BUFFER_SIZE` | Integer | `10000` | Set the buffer size for log retrieval if `LANGFLOW_ENABLE_LOG_RETRIEVAL=true`. Must be greater than `0` for log retrieval to function. |docs/docs/Components/bundles-mistralai.mdx (4)
31-31: Clarify “0 = unlimited tokens” and document default.Confirm that
0is supported by the component/provider and add an explicit default value in code style.-| max_tokens | Integer | Input parameter. The maximum number of tokens to generate. Set to 0 for unlimited tokens. | +| max_tokens | Integer | Input parameter. The maximum number of tokens to generate. Set to `0` for unlimited tokens. Default: `1000`. |If the default differs, adjust accordingly. Based on guidelines.
33-33: Minor: backtick URL for consistency.-| mistral_api_base | String | Input parameter. The base URL of the Mistral API. Defaults to `https://api.mistral.ai/v1`. | +| mistral_api_base | String | Input parameter. The base URL of the Mistral API. Default: `https://api.mistral.ai/v1`. |
36-40: Standardize default formatting (wrap numerics in backticks).Make numeric defaults consistent with boolean defaults elsewhere.
-| max_retries | Integer | Input parameter. Maximum number of retries for API calls. Default: 5. | -| timeout | Integer | Input parameter. Timeout for API calls in seconds. Default: 60. | -| max_concurrent_requests | Integer | Input parameter. Maximum number of concurrent API requests. Default: 3. | -| top_p | Float | Input parameter. Nucleus sampling parameter. Default: 1. | -| random_seed | Integer | Input parameter. Seed for random number generation. Default: 1. | +| max_retries | Integer | Input parameter. Maximum number of retries for API calls. Default: `5`. | +| timeout | Integer | Input parameter. Timeout for API calls in seconds. Default: `60`. | +| max_concurrent_requests | Integer | Input parameter. Maximum number of concurrent API requests. Default: `3`. | +| top_p | Float | Input parameter. Nucleus sampling parameter. Default: `1`. | +| random_seed | Integer | Input parameter. Seed for random number generation. Default: `1`. |
41-41: Document the default forsafe_mode.Add explicit default and (if applicable) note provider behavior.
-| safe_mode | Boolean | Input parameter. Enables safe mode for content generation. | +| safe_mode | Boolean | Input parameter. Enables safe mode for content generation. Default: `false`. |Adjust if the actual default differs.
docs/docs/Components/bundles-chroma.mdx (2)
73-73: Tighten wording; avoid repeated “Iffalse…”.Clarify deduplication behavior and reference
limitonce.-| **Allow Duplicates** (`allow_duplicates`) | Boolean | Input parameter. If `true` (default), writes don't check for existing duplicates in the collection, allowing you to store multiple copies of the same content. If `false`, writes won't add documents that match existing documents already present in the collection. If `false`, it can strictly enforce deduplication by searching the entire collection or only search the number of records, specified in `limit`. Only relevant for writes.| +| **Allow Duplicates** (`allow_duplicates`) | Boolean | Input parameter. If `true` (default), writes don't check for duplicates and may store multiple copies. If `false`, writes skip documents that match existing ones. Deduplication can search the entire collection or only the first `limit` records (for performance). Only relevant for writes. |
76-76: Clarify thatlimitapplies only when duplicates are disallowed.-| **Limit** (`limit`) | Integer | Input parameter. Limit the number of records to compare when **Allow Duplicates** is `false`. This can help improve performance when writing to large collections, but it can result in some duplicate records. Only relevant for writes. | +| **Limit** (`limit`) | Integer | Input parameter. When **Allow Duplicates** is `false`, limits how many existing records are compared for deduplication. Improves write performance on large collections but may allow some duplicates. Only relevant for writes. |docs/docs/Components/components-custom-components.mdx (2)
159-166: Verifygroup_outputslocation and semantics.Example sets
group_outputsat the Output level; confirm if this flag is component-level or per-output in current API. If component-level, update examples accordingly. Also confirm default isFalse.I can adjust the examples once you confirm the correct API surface.
300-303: Boolean flag formatting LGTM; add brief defaults note.Consider adding “Default:
false” where defaults exist to reduce ambiguity.docs/docs/Components/bundles-ibm.mdx (2)
19-19: Minor style: strengthen placement.Consider moving this line above the image to keep narrative flow (intro → usage claim → diagram).
74-74: Embeddings table consistency and boolean default.
- Header uses “Name | Display Name | Info” vs. other tables “Name | Type | Description”. Consider standardizing.
input_textdefaulttruelooks good; add type for consistency (Boolean).-| Name | Display Name | Info | +| Name | Type | Description | @@ -| input_text | Include the original text in the output | Input parameter. Determines if the original text is included in the output. Default: `true`. | +| input_text | Boolean | Input parameter. Determines if the original text is included in the output. Default: `true`. |docs/docs/API-Reference/api-build.mdx (3)
6-12: Use allowed admonition type per guidelines; emphasize caution.Guidelines list
:::tip,:::warning,:::danger. Replace:::infowith:::warningto discourage external use.-:::info +:::warning The `/build` endpoints are used by Langflow's frontend visual editor code. These endpoints are part of the internal Langflow codebase. Don't use these endpoints to run flows in applications that use your Langflow flows. To run flows in your apps, see [Flow trigger endpoints](/api-flows-run). :::As per coding guidelines.
72-80: Confirmstreamdefault and add param table entry.Verify
streamdefaults totrueserver-side and consider adding it to the parameters table with default shown.+| stream | Boolean | Optional. Stream events as Server-Sent Events. Default: `true`. |
14-17: Tighten scope statement.Consider: “Primarily relevant when contributing to Langflow or debugging the editor.” to reduce ambiguity.
docs/docs/Components/components-data.mdx (2)
82-84: Capitalize HTTPX; otherwise looks good.Inline-code defaults are consistent. Please change “HTTPx” to “HTTPX” in the display name to match the library’s proper casing.
-| include_httpx_metadata | Include HTTPx Metadata | Input parameter. Whether to include properties such as `headers`, `status_code`, `response_headers`, and `redirection_history` in the output. Default: Disabled (`false`) | +| include_httpx_metadata | Include HTTPX Metadata | Input parameter. Whether to include properties such as `headers`, `status_code`, `response_headers`, and `redirection_history` in the output. Default: Disabled (`false`) |
429-431: Wording nit: “Add Error” → “Include Errors”.Display name reads more naturally as “Include Errors” and matches the phrasing used elsewhere.
-| add_error | Add Error | Input parameter. If enabled, adds any error messages to the result, if any are returned. The default is disabled (`false`). | +| add_error | Include Errors | Input parameter. If enabled, appends any error messages to the result. Default: Disabled (`false`). |docs/docs/Integrations/Nvidia/integrations-nvidia-ingest.mdx (1)
75-91: Boolean default formatting is consistent; one style nit.Nice use of inline-code for defaults. In the “Text Depth” row (Line 80), consider using backticks for option tokens instead of single quotes for consistency with the style guide.
-| text_depth | Text Depth | The level at which text is extracted. Options: 'document', 'page', 'block', 'line', 'span'. Default: `page`. | +| text_depth | Text Depth | The level at which text is extracted. Options: `document`, `page`, `block`, `line`, `span`. Default: `page`. |
| 5. In the **Prompt Template** component's **Template** field, add a variable like `{searchresults}` or `{context}`. | ||
|
|
||
| This adds a field to the **Prompt Template** component that you can use to pass the converted search results to the prompt. | ||
| For more information, see [Define variables in prompts](/components-prompts#define-variables-in-prompts). |
There was a problem hiding this comment.
Fix step numbering jump (3 → 5).
Use Markdown auto-numbering (“1.” for each item) to avoid future renumbering issues.
-5. In the **Prompt Template** component's **Template** field, add a variable like `{searchresults}` or `{context}`.
+1. In the **Prompt Template** component's **Template** field, add a variable like `{searchresults}` or `{context}`.Additionally, consider converting the whole list (Lines 494–510) to “1.” style for all steps to ensure consistent auto-numbering.
Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In docs/docs/Components/components-data.mdx around lines 494 to 510, the ordered
list currently jumps from step 3 to 5 (line 507); update the list items to use
Markdown auto-numbering by replacing each manual numeral (e.g., "1.", "2.",
"3.", "4.", "5.", etc.) with "1." for every item so the renderer auto-numbers
them consistently; apply this change across the entire list (lines 494–510) to
prevent future renumbering issues and ensure the reference link at line 507
remains unchanged.
3 participants
trueandfalsevalues.(advanced)from some parameter definitions.:::importantwith other admonition types becauseimportantisn't a built-in docusaurus type.Summary by CodeRabbit
Expanded Agent setup guide with credentials, provider/model guidance, tool integration, and Tool Mode workflow.Added streaming control example (?stream=false) and updated curl sample.