Skip to content

docs: Update, refresh, and expand Vector Store and Processing component documentation#9407

Merged
mendonk merged 21 commits into
mainfrom
lfoss-1550
Aug 18, 2025
Merged

docs: Update, refresh, and expand Vector Store and Processing component documentation#9407
mendonk merged 21 commits into
mainfrom
lfoss-1550

Conversation

@aimurphy
Copy link
Copy Markdown
Collaborator

@aimurphy aimurphy commented Aug 15, 2025

  • More updates to the Processing components page that I didn't get to in previous PRs.
  • Lots of updates to Vector Store components regarding output types, underlying LangChain classes, how to use them in flows, and try to reorganize the page for a bit easier skimming.

Summary by CodeRabbit

  • Documentation
    • Processing components docs overhauled with tabs, expanded examples, and documented API updates (including Save File rename, Data Operations, LLM Router, Parser, Structured Output, Type Convert, Split Text, data types, and legacy migration guidance).
    • Logic components docs expanded: more flexible If-Else inputs; Loop lifecycle, incompatibilities, examples, and conditional looping guidance.
    • Data types docs clarified, restructured, and cross-linked.
    • Configuration docs: added CLI anchor, unified environment variable references, and grammar fix.
    • Minor tweaks: updated links, whitespace, and wording/emphasis in Agents, Data, Tutorials, and Troubleshooting.

@aimurphy aimurphy self-assigned this Aug 15, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 15, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Documentation updates across multiple pages. Components-Processing underwent extensive revisions, including renames and parameter surface changes (e.g., Save To File → Save File, Data Operations, LLM Router, Parser, Structured Output, Type Convert, Split Text). Other files received wording, formatting, anchors, and link updates. No code changes.

Changes

Cohort / File(s) Summary
Components – Agents & Data
docs/docs/Components/components-agents.mdx, docs/docs/Components/components-data.mdx
Minor wording/formatting updates: “base LLM model” → “base LLM”; bolded “Processing” in guidance.
Components – Logic
docs/docs/Components/components-logic.mdx
Expanded If-Else input guidance; major Loop doc restructuring, added incompatibility note with If-Else, new sections (looping process, example, conditional looping), formatting updates.
Components – Processing
docs/docs/Components/components-processing.mdx
Large refactor: Tabs UI; Save To File → Save File; Batch Run terminology; major API documentation changes for Data Operations, DataFrame Operations, LLM Router, Parser, Structured Output, Type Convert, Split Text; expanded data type representations; legacy migration guidance.
Concepts – Data Types
docs/docs/Concepts/data-types.mdx
Reframed Data object semantics, removed separate structure subsection, tightened examples, updated cross-links (including Type Convert), added “See also” items.
Configuration – Auth, CLI, Env Vars
docs/docs/Configuration/api-keys-and-authentication.mdx, docs/docs/Configuration/configuration-cli.mdx, docs/docs/Configuration/environment-variables.mdx
Grammar fix (“a .env”); added anchor for langflow run; env var docs consolidated to reference langflow run, clarified LANGFLOW_LANGCHAIN_CACHE vs LANGFLOW_CACHE_TYPE.
Support – Troubleshooting
docs/docs/Support/troubleshooting.mdx
Updated “Memory management options” link target.
Tutorials – Chat with files
docs/docs/Tutorials/chat-with-files.mdx
Whitespace-only formatting adjustments between steps.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~40 minutes

Possibly related PRs

Suggested labels

documentation, size:XL, lgtm

Suggested reviewers

  • mendonk
  • edwinjosechittilappilly
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch lfoss-1550

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

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

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 15, 2025
@github-actions

This comment has been minimized.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Aug 15, 2025
@aimurphy aimurphy requested a review from mendonk August 15, 2025 03:29
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🔭 Outside diff range comments (8)
docs/docs/Components/components-agents.mdx (1)

1-4: Add required description to frontmatter

Per the docs guidelines, every page must include a description in frontmatter. Please add a concise summary.

 ---
 title: Agents
 slug: /components-agents
+description: Build agent flows in Langflow using the Agent and MCP Tools components, how tools work, and where to find examples.
 ---
docs/docs/Configuration/api-keys-and-authentication.mdx (1)

1-4: Add required description to frontmatter

This page is missing a description in frontmatter.

 ---
 title: API keys and authentication
 slug: /api-keys-and-authentication
+description: Learn how to manage Langflow API keys, component credentials, and environment variables to enable secure authentication and authorization.
 ---
docs/docs/Configuration/configuration-cli.mdx (1)

1-4: Add required description to frontmatter

Please include a description.

 ---
 title: Langflow CLI
 slug: /configuration-cli
+description: Reference for the Langflow command line interface, including commands, options, precedence rules, and examples.
 ---
docs/docs/Support/troubleshooting.mdx (2)

1-4: Add required description to frontmatter

Add a concise description to comply with guidelines.

 ---
 title: Troubleshoot Langflow
 slug: /troubleshoot
+description: Common issues and fixes for installing, starting, upgrading, and using Langflow across OSS and Desktop.
 ---

168-170: Fix path in removal command

Text references ~/.langflow, but the command misses the tilde. This can lead to removing a relative directory instead of the intended home path.

-    rm -rf .langflow
+    rm -rf ~/.langflow
docs/docs/Tutorials/chat-with-files.mdx (2)

1-4: Add required description to frontmatter

Please add a description for compliance and better searchability.

 ---
 title: Create a chatbot that can ingest files
 slug: /chat-with-files
+description: Tutorial to build a Langflow chatbot that accepts uploaded files and answers questions using their contents, including a Python example for file upload and flow execution.
 ---

97-111: Fix file upload example: incorrect filename/path usage and unclosed file handle

The example swaps FILE_NAME/FILE_PATH, uses a raw string instead of variables, and leaves the file handle open. Also, requests.post is clearer than requests.request("POST", ...).

-    # 2. Prepare the file and payload
-    payload = {}
-    files = [
-      ('file', ('FILE_PATH', open('FILE_NAME', 'rb'), 'application/octet-stream'))
-    ]
-    headers = {
+    # 2. Prepare the file and payload
+    payload = {}
+    headers = {
       'Accept': 'application/json',
       'x-api-key': 'LANGFLOW_API_KEY'
     }
 
-    # 3. Upload the file to Langflow
-    response = requests.request("POST", url, headers=headers, data=payload, files=files)
-    print(response.text)
+    # 3. Upload the file to Langflow
+    with open('FILE_PATH', 'rb') as f:
+        files = [('file', ('FILE_NAME', f, 'application/octet-stream'))]
+        response = requests.post(url, headers=headers, data=payload, files=files)
+        print(response.text)

If you prefer, I can also refactor this example to define placeholders as variables at the top for easier copy/paste.

docs/docs/Components/components-data.mdx (1)

289-296: Fix SQL example output to match inserted rows

The SELECT output doesn’t match the inserted rows. It repeats John/Jane and omits Bob.

-        1|John Doe|john@example.com
-        2|Jane Smith|jane@example.com
-        3|John Doe|john@example.com
-        4|Jane Smith|jane@example.com
+        1|John Doe|john@example.com|30
+        2|Jane Smith|jane@example.com|25
+        3|Bob Johnson|bob@example.com|35

Optionally include age if your sqlite3 output formatting matches the full table schema. If not, keep only the three rows in correct order and names.

🧹 Nitpick comments (20)
docs/docs/Configuration/api-keys-and-authentication.mdx (1)

81-82: Minor grammar fix: add “in”

Small readability improvement.

-To authenticate Langflow API requests, pass your Langflow API key an `x-api-key` header or query parameter.
+To authenticate Langflow API requests, pass your Langflow API key in an `x-api-key` header or query parameter.
docs/docs/Configuration/configuration-cli.mdx (1)

258-259: Minor grammar fix: missing “about”

Tighten phrasing.

-For more information Langflow configuration options, see [Langflow environment variables](/environment-variables).
+For more information about Langflow configuration options, see [Langflow environment variables](/environment-variables).
docs/docs/Support/troubleshooting.mdx (1)

149-150: Verify updated link target

The link now points to /memory. Please confirm this is the canonical destination for cache locations and default filepaths, or update to the specific section anchor if available.

docs/docs/Components/components-data.mdx (4)

53-60: Grammar: “an HTTP requests” → “an HTTP request”

Minor copy fix for subject/verb agreement.

-The **API Request** component constructs and sends an HTTP requests using URLs or curl commands:
+The **API Request** component constructs and sends an HTTP request using URLs or curl commands:

80-82: Parameter naming consistency and default formatting

  • Consider aligning default formatting across parameters (true/false vs Enabled/Disabled).
  • “Include HTTPx Metadata” capitalization is inconsistent with the library name (“HTTPX” or “httpx”).
-| 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) |

168-171: Clarify phrasing: “either can throw an error”

Reads awkwardly. Simplify to a single, clear outcome.

-| ignore_unsupported_extensions | Ignore Unsupported Extensions | Input parameter. If enabled (true), files with unsupported extensions are accepted but not processed. If disabled (false), the **File** component either can throw an error if an unsupported file type is provided. The default is true. |
+| ignore_unsupported_extensions | Ignore Unsupported Extensions | Input parameter. If enabled (true), files with unsupported extensions are accepted but not processed. If disabled (false), the **File** component throws an error if an unsupported file type is provided. Default: Enabled (true). |

410-414: Use a supported admonition type (Docusaurus)

Docusaurus supports note, tip, info, warning, and danger by default. “important” may not render.

-:::important
+:::warning
 The **Web Search** component uses web scraping that can be subject to rate limits.
 
 For production use, consider using another search component with more robust API support, such as a provider-specific [bundle](/components-bundle-components).
 :::
docs/docs/Configuration/environment-variables.mdx (3)

416-435: UI label: “Window System Properties” → “Windows System Properties”

Minor copy fix.

-<TabItem value="windows1" label="Window System Properties">
+<TabItem value="windows1" label="Windows System Properties">

439-451: Typos and capitalization: PowerShell and privileges

  • PowerShell capitalization
  • “priveleges” → “privileges”
-<TabItem value="windows2" label="Powershell">
+<TabItem value="windows2" label="PowerShell">
@@
-   To set an environment variable for all users (you must have Administrator priveleges):
+   To set an environment variable for all users (you must have Administrator privileges):

199-201: Units vs examples: Worker timeout seconds but examples use 60000

The table says seconds (default 300), but examples set 60000. If users copy this, they may set a 16+ hour timeout unintentionally. Consider harmonizing or clarifying units in examples.

Would you like me to generate a pass that changes example values to a realistic seconds-based value (e.g., 600) or add “(seconds)” to each example?

docs/docs/Components/components-processing.mdx (7)

154-161: Parameter name consistency: “operation” vs “operations”

The section below says “Options for the operations input parameter” (plural) but the parameter is operation (singular). Align the wording.

-#### Available data operations
+#### Available Data Operations
@@
-Options for the `operations` input parameter are as follows.
+Options for the `operation` input parameter are as follows.

369-396: LLM Router: call out external dependency and credentials

Fetching OpenRouter specs implies an external API call and may require an API key or rate limits. Consider adding a short note about prerequisites and potential latency.

 | `use_openrouter_specs` | **Use OpenRouter Specs** | Input parameter. Whether to fetch model specifications from the OpenRouter API.
-If false, only the model name is provided to the judge LLM. Default: Enabled (true) |
+If false, only the model name is provided to the judge LLM. Default: Enabled (true).
+Note: Using OpenRouter specs may require an OpenRouter API key and incurs an external API call that can add latency. |

561-566: Minor copy edit: missing space after comma

-1. To use this component in a flow,in the **Global Imports** field, add the packages you want to import as a comma-separated list, such as `math,pandas`.
+1. To use this component in a flow, in the **Global Imports** field, add the packages you want to import as a comma-separated list, such as `math,pandas`.

662-667: Admonition type and sentence fragments in Save File formats

  • “:::important” may not be supported by Docusaurus default.
  • The three bullet lines are fragments; acceptable, but consider smoothing repetition.
-    :::important Overwrites allowed
+    :::warning Overwrites allowed
@@
-    * `DataFrame` can be saved to CSV (default), Excel (requires `openpyxl` [custom dependency](/install-custom-dependencies)), JSON (fallback default), or Markdown.
+    * `DataFrame` can be saved to CSV (default), Excel (requires `openpyxl` [custom dependency](/install-custom-dependencies)), JSON (fallback default), or Markdown.
@@
-    * `Data` can be saved to CSV, Excel (requires `openpyxl` [custom dependency](/install-custom-dependencies)), JSON (default), or Markdown.
+    * `Data` can be saved to CSV, Excel (requires `openpyxl` [custom dependency](/install-custom-dependencies)), JSON (default), or Markdown.
@@
-    * `Message` can be saved to TXT, JSON (default), or Markdown.
+    * `Message` can be saved to TXT, JSON (default), or Markdown.

If you want to reduce repetition, I can consolidate these bullets.


698-711: Tip about instruction brevity is helpful; caveat about punctuation is surprising

If punctuation truly causes issues, consider explaining why (parser sensitivity) or link to a known issue.

I can add a short rationale or a link to a troubleshooting section if available.


751-757: Duplicate word and minor clarity in Split Text

  • “exceed the the chunk_size” → “exceed the chunk_size
  • Consider clarifying behavior when separator isn’t found in long spans (do we still avoid subdividing?).
-| chunk_size | Chunk Size | Input parameter. The target length for each chunk after splitting. The data is first split by separator, and then chunks smaller than the `chunk_size` are merged up to this limit. However, if the initial separator split produces any chunks larger than the `chunk_size`, those chunks are neither further subdivided nor combined with any smaller chunks; these chunks will be output as-is even though they exceed the the `chunk_size`. Default: `1000`. |
+| chunk_size | Chunk Size | Input parameter. The target length for each chunk after splitting. The data is first split by separator, and then chunks smaller than the `chunk_size` are merged up to this limit. However, if the initial separator split produces any chunks larger than the `chunk_size`, those chunks are neither further subdivided nor combined with any smaller chunks; these chunks are output as-is even if they exceed the `chunk_size`. Default: `1000`. |

882-907: JSON snippet under Data is not a valid JSON root

The example shows only the inner “data” dict. Either label it as an excerpt or wrap with the full object to be copy-pasteable.

-```json
-"data": {
-  "text": "User Profile",
-  "name": "Charlie Lastname",
-  "age": 28,
-  "email": "charlie.lastname@example.com"
-},
-```
+```json
+{
+  "text_key": "text",
+  "data": {
+    "text": "User Profile",
+    "name": "Charlie Lastname",
+    "age": 28,
+    "email": "charlie.lastname@example.com"
+  },
+  "default_value": ""
+}
+```

If you prefer to keep it as an excerpt, add a comment note like “(excerpt)” and switch to jsonc.

docs/docs/Components/components-logic.mdx (3)

102-104: Grammar: “a list of input” and number agreement

Tighten language and fix pluralization.

-The **Loop** component iterates over a list of input by passing individual items to other components attached at the **Item** output port until there are no items left to process.
+The **Loop** component iterates over a list of inputs by passing individual items to components attached to the **Item** output port until there are no items left to process.
@@
-Then, the **Loop** component passes the aggregated result of all looping to the component connected to the **Done** port.
+Then, the **Loop** component passes the aggregated results of the loop to the component connected to the **Done** port.

114-116: Pluralization: “a Data objects”

-Each `item` output is a `Data` objects.
+Each `item` output is a `Data` object.

145-151: Copy edit: “follow example” → “following example”

-In the follow example, the **Loop** component iterates over a CSV file until there are no rows left to process.
+In the following example, the **Loop** component iterates over a CSV file until there are no rows left to process.
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 226c71b and d9611e2.

⛔ Files ignored due to path filters (1)
  • docs/static/img/conditional-looping.png is excluded by !**/*.png
📒 Files selected for processing (10)
  • docs/docs/Components/components-agents.mdx (1 hunks)
  • docs/docs/Components/components-data.mdx (1 hunks)
  • docs/docs/Components/components-logic.mdx (5 hunks)
  • docs/docs/Components/components-processing.mdx (9 hunks)
  • docs/docs/Concepts/data-types.mdx (3 hunks)
  • docs/docs/Configuration/api-keys-and-authentication.mdx (1 hunks)
  • docs/docs/Configuration/configuration-cli.mdx (1 hunks)
  • docs/docs/Configuration/environment-variables.mdx (2 hunks)
  • docs/docs/Support/troubleshooting.mdx (1 hunks)
  • docs/docs/Tutorials/chat-with-files.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/docs/**/*.{md,mdx}

📄 CodeRabbit Inference Engine (.cursor/rules/docs_development.mdc)

docs/docs/**/*.{md,mdx}: All documentation content must be written in Markdown or MDX files located under docs/docs/, following the prescribed directory structure for guides, reference, how-to, concepts, and API documentation.
All documentation Markdown and MDX files must begin with a frontmatter block including at least title and description fields.
Use admonitions (:::tip, :::warning, :::danger) in Markdown/MDX files to highlight important information, warnings, or critical issues.
All images referenced in documentation must include descriptive alt text for accessibility.
All code examples included in documentation must be tested and verified to work as shown.
Internal links in documentation must be functional and not broken.
Content must follow the style guide: professional but approachable tone, second person voice, present tense, short paragraphs, sentence case headers, inline code with backticks, bold for UI elements, italic for emphasis, and parallel structure in lists.
Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.

Files:

  • docs/docs/Components/components-agents.mdx
  • docs/docs/Configuration/configuration-cli.mdx
  • docs/docs/Configuration/api-keys-and-authentication.mdx
  • docs/docs/Support/troubleshooting.mdx
  • docs/docs/Tutorials/chat-with-files.mdx
  • docs/docs/Concepts/data-types.mdx
  • docs/docs/Configuration/environment-variables.mdx
  • docs/docs/Components/components-data.mdx
  • docs/docs/Components/components-logic.mdx
  • docs/docs/Components/components-processing.mdx
🧠 Learnings (2)
📚 Learning: 2025-07-18T18:26:42.027Z
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.

Applied to files:

  • docs/docs/Components/components-data.mdx
📚 Learning: 2025-06-23T12:46:52.420Z
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/icons.mdc:0-0
Timestamp: 2025-06-23T12:46:52.420Z
Learning: When implementing a new component icon in Langflow, ensure the icon name is clear, recognizable, and used consistently across both backend (Python 'icon' attribute) and frontend (React/TypeScript mapping).

Applied to files:

  • docs/docs/Components/components-processing.mdx
🪛 LanguageTool
docs/docs/Components/components-processing.mdx

[grammar] ~7-~7: There might be a mistake here.
Context: ...s/icon"; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; L...

(QB_NEW_EN)


[grammar] ~211-~211: There might be a mistake here.
Context: ...ing components: * API Request * Language Model * **Smart Funct...

(QB_NEW_EN)


[grammar] ~212-~212: There might be a mistake here.
Context: ...API Request** * Language Model * Smart Function * **Type Conver...

(QB_NEW_EN)


[grammar] ~213-~213: There might be a mistake here.
Context: ...guage Model** * Smart Function * Type Convert 2. Configure the [**...

(QB_NEW_EN)


[grammar] ~220-~220: There might be a mistake here.
Context: ...** component's Language Model input. * Smart Function: In the *Instructions...

(QB_NEW_EN)


[grammar] ~375-~375: There might be a mistake here.
Context: ...has three Language Model components. One is the judge LLM, and the other two ...

(QB_NEW_EN)


[grammar] ~431-~431: There might be a mistake here.
Context: ...e following: * Batch Run component * [Structured Output component](#structur...

(QB_NEW_EN)


[grammar] ~432-~432: There might be a mistake here.
Context: ...-run) * Structured Output component * Financial Report Parser template * [**...

(QB_NEW_EN)


[grammar] ~433-~433: There might be a mistake here.
Context: ...) * Financial Report Parser template * [Vector Store components](/components-v...

(QB_NEW_EN)


[grammar] ~434-~434: There might be a mistake here.
Context: ... template * Vector Store components * Trigger flows with webhooks *...

(QB_NEW_EN)


[grammar] ~435-~435: There might be a mistake here.
Context: ...r-stores) * Trigger flows with webhooks * [Create a vector RAG chatbot](/chat-with-...

(QB_NEW_EN)


[grammar] ~552-~552: There might be a mistake here.
Context: ...ut**, and Smart Function components. * Enable the Parser component's **Clea...

(QB_NEW_EN)


[style] ~662-~662: To form a complete sentence, be sure to include a subject.
Context: ...the input data type: * DataFrame can be saved to CSV (default), Excel (requi...

(MISSING_IT_THERE)


[style] ~664-~664: To form a complete sentence, be sure to include a subject.
Context: ...ck default), or Markdown. * Data can be saved to CSV, Excel (requires `openp...

(MISSING_IT_THERE)


[style] ~666-~666: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...default), or Markdown. * Message can be saved to TXT, JSON (default), or Mar...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[grammar] ~705-~705: There might be a mistake here.
Context: ...through a Prompt Template component. ::: The following example uses the **AP...

(QB_NEW_EN)


[grammar] ~753-~753: There might be a mistake here.
Context: ...utput as-is even though they exceed the the chunk_size. Default: 1000. | | sepa...

(QB_NEW_EN)


[style] ~765-~765: This phrase is redundant. Consider writing “details”.
Context: ...efinition. For example, you can extract specific details from documents, like email messages or ...

(SPECIFIC_DETAILS)


[grammar] ~936-~936: There might be a mistake here.
Context: ...arily for passing a text string, such as`"Name: Charlie Lastname, Age: 28, Email: charl...

(QB_NEW_EN)


[grammar] ~936-~936: There might be a mistake here.
Context: ..., Email: charlie.lastname@example.com". However, the entire Message` object can...

(QB_NEW_EN)


[style] ~966-~966: Consider a more concise word here.
Context: ...o change the DataFrame to a Message in order to pass the search results to the **Prompt...

(IN_ORDER_TO_PREMIUM)


[style] ~971-~971: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Type Convert** component's input. * Connect the Type Convert component's output...

(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 (26)
docs/docs/Components/components-agents.mdx (1)

46-46: Wording improvement LGTM

“base LLM” reads cleaner and is consistent with the style elsewhere.

docs/docs/Configuration/configuration-cli.mdx (1)

233-233: Anchor addition LGTM

The explicit anchor on “langflow run” improves cross-linking and aligns with other docs.

docs/docs/Tutorials/chat-with-files.mdx (1)

34-37: Whitespace change LGTM

The added blank lines improve readability of the steps.

docs/docs/Components/components-data.mdx (2)

399-401: Good cross-link and terminology consistency

“Processing components” capitalization and the Type Convert link align with the style guide and other updated docs.


485-491: API example looks good

curl example includes content type and API key header, and the endpoint path matches the earlier description.

docs/docs/Configuration/environment-variables.mdx (2)

118-137: Great: CLI usage with --env-file is clear across local and Docker

Consistent with precedence rules and helps users avoid environment drift.


154-174: Anchor present: /configuration-cli#langflow-run

Confirmed the anchor langflow-run exists in configuration-cli.mdx and the environment-variables references point to it — no broken links found.

  • docs/docs/Configuration/configuration-cli.mdx — ### langflow run {#langflow-run} (around line 233)
  • docs/docs/Configuration/environment-variables.mdx — references at lines 154, 166, 167, 168, 173
docs/docs/Concepts/data-types.mdx (2)

261-271: Nice contextual cross-link to Type Convert

The link to /components-processing#type-convert reflects the updated Processing docs and helps users discover conversions.


342-345: Consistent capitalization and “Processing” link

The “See also” section uses the standardized “Processing components” link and capitalization as per the style guide.

docs/docs/Components/components-processing.mdx (14)

7-9: Imports for Tabs/TabItem look correct

Good preparation for the new tabbed sections.


26-32: Batch Run: column names and semantics are clear

“text_input”, “model_response”, “batch_index”, and optional “metadata” are well-defined. Works with the downstream Parser example.


35-37: Parser cross-reference clarity

Good guidance using Parser with Batch Run keys.


61-62: UI action capitalization and icon usage

Minor nit: match existing style by using sentence case consistently for button names (“Run component”, “Inspect output”) — which you already did here. Looks good.


82-85: Good: Data Operations overview matches the new single-operation surface

Clear description of scope and outputs.


96-104: Single-operation constraint is clear; chaining advice is helpful

The tip avoids user confusion and provides a path for multi-step edits.


185-193: DataFrame Operations overview reads well

Accurately sets expectations and links to the parameters section.


274-366: Tabbed operations are a great UX improvement

The per-operation parameters under Tabs are clear and consistent. Nice coverage.


349-363: Drop Duplicates: clarify behavior for multi-column dedup?

Currently says “within a single column.” If multi-column keys are unsupported, that’s fine. If supported, specify parameter(s) like “subset columns.”

I can update the text to include “subset columns” if the component supports it.


402-419: Routing Decision output is a valuable debugging aid

Good example; clear mapping of what users can expect.


444-505: Parser: template mode parameters and examples are solid

The variable substitution explanation is concise and actionable. The examples are easy to reproduce.


523-554: Troubleshooting section is practical

Covers likely pitfalls and how to diagnose them using Inspect output and upstream checks.


949-994: Type Convert flow example is clear and reproducible

The steps, variable wiring, and image align with the earlier Web Search doc.


999-1002: Parameter names and behaviors are concise

Matches the updated Processing surface where output port changes by selected type.

docs/docs/Components/components-logic.mdx (3)

36-40: Excellent guidance on acceptable input types and transformations

Calling out Type Convert and Parser as adapters, and suggesting Data Operations if Message isn’t appropriate, is actionable.


129-131: Helpful: clarify pseudo-code disclaimer

The preface makes it clear this is conceptual, not literal implementation. Nicely done.


157-164: Conditional looping section is clear

Directs users away from If-Else in loops and toward pre-filtering with DataFrame Operations.

Comment thread docs/docs/Concepts/data-types.mdx
Comment thread docs/docs/Configuration/api-keys-and-authentication.mdx
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Aug 15, 2025
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Aug 15, 2025
@github-actions

This comment has been minimized.

Copy link
Copy Markdown
Collaborator

@mendonk mendonk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved, and fixed the kv pair issue that coderabbit noticed

@github-actions github-actions Bot added the lgtm This PR has been approved by a maintainer label Aug 15, 2025
@mendonk mendonk enabled auto-merge August 15, 2025 20:49
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Aug 18, 2025
@sonarqubecloud
Copy link
Copy Markdown

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Aug 18, 2025

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

@mendonk mendonk added this pull request to the merge queue Aug 18, 2025
Merged via the queue into main with commit cfb2913 Aug 18, 2025
16 checks passed
@mendonk mendonk deleted the lfoss-1550 branch August 18, 2025 13:57
lucaseduoli pushed a commit that referenced this pull request Aug 22, 2025
…nt documentation (#9407)

* fix anchors

* type convert and structured output components

* vector store intro and flow example

* reorg some vector search components by provider

* still on vector stores

* vector store example and outputs

* finish vector store page

* corrections to astra db vector store

* start split text component

* save file and smart function

* llm router

* parser

* still on dataframe

* finish datafram ops

* remove-extra-kv-pair-and-clarify-serialization-from-python

---------

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
lucaseduoli pushed a commit that referenced this pull request Aug 25, 2025
…nt documentation (#9407)

* fix anchors

* type convert and structured output components

* vector store intro and flow example

* reorg some vector search components by provider

* still on vector stores

* vector store example and outputs

* finish vector store page

* corrections to astra db vector store

* start split text component

* save file and smart function

* llm router

* parser

* still on dataframe

* finish datafram ops

* remove-extra-kv-pair-and-clarify-serialization-from-python

---------

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants