docs: Standardize style of component names, especially when used in links#9251
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 change set revises numerous documentation files across API references, components, integrations, tutorials, and conceptual guides. The updates focus on improving clarity, consistency, formatting, and accuracy of terminology, particularly in component names and step-by-step instructions. No code or API behavior is altered. Changes
Sequence Diagram(s)No sequence diagram generated, as the changes are purely documentation and do not affect control flow or feature logic. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
github-actions
Bot
added
documentation
|
Build successful! ✅ |
![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
🔭 Outside diff range comments (22)
docs/docs/Concepts/concepts-playground.mdx (1)
1-4: Add the mandatorydescriptionfield to the front-matter
All docs pages must include at leasttitleanddescription. The latter is missing here.--- title: Test flows in the Playground slug: /concepts-playground +description: Learn how to run, debug, and iterate on Langflow flows in the Playground. ---docs/docs/Develop/develop-application.mdx (1)
1-4: Missingdescriptionin front-matter
Add a short description to satisfy the docs meta-data requirement.--- title: Containerize a Langflow application slug: /develop-application +description: Step-by-step guide for packaging and deploying a Langflow flow inside a Docker image. ---docs/docs/Develop/logging.mdx (1)
1-4: Front-matter incomplete
Adescriptionfield is required.--- title: Logs slug: /logging +description: Configure, locate, and inspect Langflow application and flow logs. ---docs/docs/API-Reference/api-reference-api-examples.mdx (1)
1-4: Add adescriptionto front-matter
Required by the docs style guide.--- title: Get started with the Langflow API slug: /api-reference-api-examples +description: Learn common patterns and examples for calling the Langflow REST API. ---docs/docs/Develop/session-id.mdx (1)
1-4: Front-matter needs adescription--- title: Use session ID to manage communication between components slug: /session-id +description: How to pass and leverage custom session IDs in Langflow flows and API calls. ---docs/docs/Tutorials/mcp-tutorial.mdx (1)
1-4: Add adescriptionfield to the front-matter.Every docs/ page must include at least
titleanddescriptionin its front-matter per the docs style guide.
Omitting it breaks the sidebar metadata build.--- title: Connect to MCP servers from your application slug: /mcp-tutorial +description: Learn how to connect multiple Model Context Protocol (MCP) servers to a Langflow flow and consume the flow from a Python script. ---docs/docs/Concepts/concepts-file-management.mdx (1)
1-4: Front-matter missingdescription.Add a concise one-sentence summary so the page renders correctly and shows up in search.
--- title: Manage files slug: /concepts-file-management +description: Understand how to upload, manage and use files inside Langflow flows and via the API. ---docs/docs/Support/troubleshooting.mdx (1)
1-4: Add missingdescriptionto front-matter.--- title: Troubleshoot Langflow slug: /troubleshoot +description: Solutions for common installation, runtime and upgrade problems in Langflow. ---docs/docs/Components/components-agents.mdx (1)
1-4:descriptionfield is required in front-matter.--- title: Agents slug: /components-agents +description: Documentation for the Agent and MCP Tools components used to build agentic flows in Langflow. ---docs/docs/Components/bundles-aiml.mdx (1)
1-4: Insert adescriptionin front-matter.--- title: AI/ML API slug: /bundles-aiml +description: Components provided by the AI/ML bundle, including text-generation and embeddings integrations. ---docs/docs/Components/components-tools.mdx (1)
1-4: Add adescriptionfield to the front-matter.Every docs/ MDX file must provide at least
titleanddescriptionin the front-matter per the docs style guide. Missing descriptions break search and SEO.--- title: Tools slug: /components-tools +description: Overview of legacy “Tools” components, their replacements, and where to find them in the Langflow UI. ---docs/docs/Components/components-models.mdx (1)
1-4: Missingdescriptionin front-matter.Add a short description to satisfy mandatory metadata requirements.
--- title: Language Model slug: /components-models +description: Learn how to use the core **Language Model** component and provider-specific language-model bundles in Langflow. ---docs/docs/Tutorials/chat-with-files.mdx (1)
1-4: Adddescriptionto front-matter.--- title: Create a chatbot that can ingest files slug: /chat-with-files +description: Step-by-step guide to build a Langflow chatbot that reads uploaded files and answers questions about their content. ---docs/docs/Components/components-bundles.mdx (1)
1-4: Front-matter lacksdescription.--- title: About bundles slug: /components-bundle-components +description: Understand provider-specific bundle components in Langflow and how they relate to core components. ---docs/docs/Integrations/Nvidia/integrations-nvidia-g-assist.mdx (1)
1-4: Add a description to the front-matter.--- title: Integrate NVIDIA G-Assist with Langflow slug: /integrations-nvidia-g-assist +description: Use the **NVIDIA G-Assist** component to query and configure your GPU via natural-language prompts in Langflow. ---docs/docs/Components/components-embedding-models.mdx (1)
1-4: Add the requireddescriptionfield to front-matter.All docs files must include at least
titleanddescriptionin the front-matter block.--- title: Embedding Model slug: /components-embedding-models +description: Overview of **Embedding Model** components, parameters, and usage examples. ---docs/docs/Concepts/data-types.mdx (1)
1-4: Missingdescriptionin front-matter.Add a concise description per docs guidelines.
--- title: Langflow data types slug: /data-types +description: Reference for the core data types exchanged between Langflow components. ---docs/docs/Components/mcp-client.mdx (1)
1-4: Adddescriptionto front-matter.Front-matter must contain
description.--- title: Use Langflow as an MCP client slug: /mcp-client +description: Configure the **MCP Tools** component to consume tools from external or Langflow MCP servers. ---docs/docs/Get-Started/get-started-quickstart.mdx (1)
1-4: Front-matter missingdescription.Add a short description per style guide.
--- title: Quickstart slug: /get-started-quickstart +description: Load the Simple Agent template, run it, and call the flow through the Langflow API. ---docs/docs/Tutorials/agent.mdx (1)
1-4: Add mandatorydescriptionto front-matter.All MDX docs require it.
--- title: Connect applications to agents slug: /agent-tutorial +description: Tutorial – build an agentic flow and call it from a JavaScript application. ---docs/docs/Components/components-vector-stores.mdx (1)
81-85: Markdown formatting broken – unmatched asterisks around “Embedding Model”The leading
***opens bold+italic, but only**closes it, so the line renders incorrectly.-* ***Embedding Model**: Use your own embedding model by connecting an [**Embedding Model** component](/components-embedding-models) in Langflow. +* **Embedding Model**: Use your own embedding model by connecting an [**Embedding Model** component](/components-embedding-models) in Langflow.docs/docs/Components/components-custom-components.mdx (1)
402-408: Typo indisplay_name– “Mensage” should be “Message”Leaving the typo will confuse readers and anyone copy-pasting the snippet.
- display_name="Mensage", + display_name="Message",
🧹 Nitpick comments (33)
docs/docs/Components/components-logic.mdx (1)
8-8: Use the uncountable noun “functionality”Minor wording improvement.
-Langflow's **Logic** components provide functionalities for routing, conditional processing, and flow management. +Langflow's **Logic** components provide functionality for routing, conditional processing, and flow management.docs/docs/Integrations/mcp-component-astra.mdx (1)
55-55: Keep “OpenAI” bold to follow the component-name style ruleEverywhere else component names are bolded. Stay consistent:
-In the **Agent** component, add your OpenAI API key. +In the **Agent** component, add your **OpenAI** API key.docs/docs/Get-Started/about-langflow.mdx (1)
64-64: Capitalise “Agent” to match UI terminologyThe guidelines require Title Case for component/category names that appear in the UI.
-* [Use components and flows as agent tools](/agents-tools) +* [Use components and flows as Agent tools](/agents-tools)docs/docs/Support/troubleshooting.mdx (1)
17-18: Bold the “Bundles” UI category for consistency with the new style guide.Component-category names that appear in the Langflow UI should be bold inside the link.
-* Search for the component or check other component categories, including [bundles](/components-bundle-components). +* Search for the component or check other component categories, including [**Bundles**](/components-bundle-components).docs/docs/Components/components-io.mdx (3)
16-18: Use sentence-case for headingsLangflow’s docs style guide specifies “sentence case headers.”
Consider changing the heading to “## Chat input and output” (and updating the corresponding anchor if needed) for consistency.
108-110: Apply sentence-case to section titleSame style-guide issue as above – “### Use chat input and output components in a flow” would match the required sentence case.
161-168: Heading case + link wording
- Heading should be sentence case: “## Text input and output”.
- Inside the important admonition the link
[**Chat Input and Output** components](#chat-io)already follows the new “bold-inside-link” rule – nice.
Just adjust the heading case for full consistency.docs/docs/API-Reference/api-build.mdx (1)
108-110: Grammar: replace comma with colon (or split sentence)“The following example stops flow execution at an OpenAI component, run the following command:”
The comma produces a run-on sentence. Use a colon or break into two sentences:
- The following example stops flow execution at an **OpenAI** component, run the following command: + The following example stops flow execution at an **OpenAI** component. Run the following command:docs/docs/Deployment/deployment-prod-best-practices.mdx (2)
31-33: Minor wording tweak for clarity“Langflow API and UI: The Langflow service is the core part of the Langflow platform.”
Consider “core service” (singular) or “core component” to avoid the double “service” later in the sentence:
-* **Langflow API and UI**: The Langflow service is the core part of the Langflow platform. +* **Langflow API and UI**: This is the core service of the Langflow platform.
56-57: Sentence fluidity“configured to include only essential parts” feels vague.
Maybe “configured to include only the essential services” to parallel the earlier bullet.Purely stylistic – ignore if you prefer the current wording.
docs/docs/Components/bundles-huggingface.mdx (1)
68-71: Minor wording nitpick“Embedding Model ports” could be confusing because the port in these components is actually named Embedding Model only for legacy OpenAI components. In Hugging Face Embeddings Inference the port label is “Embeddings”. Consider aligning the wording so readers don’t look for a non-existent port.
docs/docs/Components/components-tools.mdx (2)
17-24: Headers need sentence-case and consistent bolding.Headers should use sentence case; component names that appear in the UI must be bold. Consider:
-## Calculator Tool +## **Calculator** tool … -## MCP Connection +## **MCP connection**This keeps the UI name bold while following the sentence-case rule.
38-55: Fix inconsistent linking and formatting for bundles list.Some bundles (
SerpApi,Tavily,Yahoo! Search) lost link wrappers and bold formatting, breaking parity with the rest of the list.- * **SerpApi** bundle - * **Tavily** bundle - * [**Wikipedia** bundle](/bundles-wikipedia) - * **Yahoo! Search** bundle + * [**SerpApi** bundle](/bundles-serpapi) + * [**Tavily** bundle](/bundles-tavily) + * [**Wikipedia** bundle](/bundles-wikipedia) + * [**Yahoo! Search** bundle](/bundles-yahoo-search)Please verify the target slugs.
docs/docs/Components/components-models.mdx (2)
15-18: Remove “in order to” verbosity.-These components accept inputs like chat messages, files, and instructions in order to generate a text response. +These components accept inputs like chat messages, files, and instructions to generate a text response.
32-34: Grammatical fix: missing article.-If you want to use provider or model that isn't built-in to the **Language Model** core component, … +If you want to use a provider or model that isn't built-in to the **Language Model** core component, …docs/docs/Tutorials/chat-with-files.mdx (1)
56-59: Flow description is wordy—trim for clarity (optional).Consider shortening the sentence for readability:
-At this point your flow has five components. The **Chat Input** and **File** components are connected to the **Prompt Template** component's input ports. Then, the **Prompt Template** component's output port is connected to the **Language Model** component's input port. Finally, the **Language Model** component's output port is connected to the **Chat Output** component, which returns the final response to the user. +Your flow now has five components: **Chat Input** and **File** feed the **Prompt Template**; its output goes to **Language Model**; the model’s **Message** output connects to **Chat Output**.docs/docs/Integrations/Nvidia/integrations-nvidia-g-assist.mdx (1)
22-26: Minor pluralisation issue.Step 1 lists “Chat Output components” (plural) even though only one is used. Suggest singular for consistency:
-1. Create a flow with **Chat Input** component, **G-Assist** component, and **Chat Output** components. +1. Create a flow with a **Chat Input** component, a **G-Assist** component, and a **Chat Output** component.docs/docs/Components/components-embedding-models.mdx (2)
37-37: Link text should keep the component name bold inside the link.Style rule:
[**<NAME>** component](…).
Current text drops the bold style:[Additional Embedding Model components]Fix:
-[Additional Embedding Model components](#additional-embedding-model-components) +[Additional **Embedding Model** components](#additional-embedding-model-components)
15-15: Header not in sentence case.Use sentence-case headings: only first word (and proper nouns/UI names) capitalised.
-## Use Embedding Model components in a flow +## Use embedding model components in a flowdocs/docs/Concepts/data-types.mdx (1)
226-226: Header should be sentence case.-### Message data in Input and Output components +### Message data in input and output componentsdocs/docs/Components/mcp-client.mdx (1)
16-16: Capitalize component name in header.
MCP Toolsis the component’s UI name; keep exact casing.-## Use the MCP tools component +## Use the MCP Tools componentdocs/docs/Tutorials/agent.mdx (1)
37-38: Prefer “component’s header menu” for consistency.Most docs use this wording; keeps UI reference precise.
-In the [header menu](/concepts-components#component-menus) for both the **Directory** and **Web Search** components, enable **Tool Mode** … +In the [component's header menu](/concepts-components#component-menus) for both the **Directory** and **Web Search** components, enable **Tool mode** …docs/docs/Integrations/Docling/integrations-docling.mdx (1)
63-65: Subject/verb agreement – use “ingests”Minor grammar slip: component ingest → component ingests.
-The **Docling** language model component ingest documents, and then uses Docling to process them by running the Docling models locally. +The **Docling** language model component ingests documents, then uses Docling to process them locally.docs/docs/Components/components-vector-stores.mdx (1)
17-18: Article misuse – “a tutorial” instead of “an tutorial”-For an tutorial using **Vector Store** components in a flow, see [Create a vector RAG chatbot](/chat-with-rag). +For a tutorial on using **Vector Store** components in a flow, see [Create a vector RAG chatbot](/chat-with-rag).docs/docs/Integrations/integrations-assemblyai.mdx (2)
130-132: Duplicate word – “in in”-4. Input the AssemblyAI API key in in all components that require the key (**Start Transcript**, **Poll Transcript**, **Get Subtitles**, **LeMUR**, **List Transcripts**). +4. Input your AssemblyAI API key in all components that require it (**Start Transcript**, **Poll Transcript**, **Get Subtitles**, **LeMUR**, **List Transcripts**).
134-135: Accessibility attribute value should be lowercase “true”-<Icon name="Play" aria-hidden="True" /> **Run component** +<Icon name="Play" aria-hidden="true" /> **Run component**Repeat the same change for the next occurrence in Step 7.
docs/docs/Integrations/Cleanlab/integrations-cleanlab.mdx (1)
106-109: Grammar – tip text is incompleteCurrent sentence is fragmentary.
-:::tip -You can to follow along. -::: +:::tip +Download the sample flow and follow along as you read. +:::docs/docs/Components/components-processing.mdx (1)
69-77: Use backticks instead of single quotes for the port nameEvery other parameter description in this table uses inline code formatting (backticks) for parameter labels.
Keeping one row in single quotes is inconsistent with the style guide and hurts scan-ability.-| model | HandleInput | Input parameter. Connect the 'Language Model' output from a **Language Model** component. Required. | +| model | HandleInput | Input parameter. Connect the `Language Model` output from a **Language Model** component. Required. |docs/docs/Concepts/concepts-components.mdx (2)
21-25: Improve list parallelism by giving “Beta” its own bulletPlacing the “Beta” qualifier inside the Core bullet breaks the one-concept-per-bullet pattern used elsewhere and can be confusing. Either move the Beta sentence out, or create a dedicated bullet:
-* **Core**: The categories near the top of the **Components** menu are Langflow's core components. They are grouped by purpose, such as **Inputs and Outputs** or **Data**. **Beta** components are newly released and still in development. +* **Core**: Categories near the top of the **Components** menu, grouped by purpose such as **Inputs and Outputs** or **Data**. +* **Beta**: Newly released components that are still in development.
239-240: Fix possessive typo “it's” → “its”-… such as a RAG **Agent** component and it's associated **Embeddings Model** … +… such as a RAG **Agent** component and its associated **Embeddings Model** …docs/docs/Agents/agents-tools.mdx (2)
158-159: Minor wording tweak for smoother reading-… example code in [Use custom components as tools](#components-as-tools) included `tool_mode=True` to the `MessageTextInput` … +… example code in [Use custom components as tools](#components-as-tools) adds `tool_mode=True` to the `MessageTextInput` …
174-183: Indent explanatory sentence to avoid breaking the ordered listMarkdown resets numbering when an un-indented line appears between list items:
3. Enable **Tool Mode**. -The selected flow becomes an [action](#edit-a-tools-actions) in the **Run Flow** component. + The selected flow becomes an [action](#edit-a-tools-actions) in the **Run Flow** component.docs/docs/Integrations/Nvidia/integrations-nvidia-ingest.mdx (1)
59-59: Make image alt text more descriptive for accessibilityConsider a more descriptive alt text that explains what the diagram shows.
- +
github-actions
Bot
added
documentation
|
Build successful! ✅ |
mendonk
left a comment
mendonk
left a comment
There was a problem hiding this comment.
3 small things but LGTM!
SonicDMG
temporarily deployed
to
lfoss-1538 - langflow-manual-install PR #9251
Render
Destroyed
SonicDMG
temporarily deployed
to
lfoss-1538 - langflow-manual-install PR #9251
Render
Destroyed
github-actions
Bot
added
documentation
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
This comment was marked as resolved.
This comment was marked as resolved.
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
|
|
Build successful! ✅ |
…inks (langflow-ai#9251) * standardize component name style and links pt 1 * component name standardization pt 2 * standardization pt 3 * standardize component names pt 4 * peer review * fix lnk * update edit tool actions section * standardize Agent, agent, agentic * more style auditing * missing imports
…inks (#9251) * standardize component name style and links pt 1 * component name standardization pt 2 * standardization pt 3 * standardize component names pt 4 * peer review * fix lnk * update edit tool actions section * standardize Agent, agent, agentic * more style auditing * missing imports
…inks (#9251) * standardize component name style and links pt 1 * component name standardization pt 2 * standardization pt 3 * standardize component names pt 4 * peer review * fix lnk * update edit tool actions section * standardize Agent, agent, agentic * more style auditing * missing imports
…inks (#9251) * standardize component name style and links pt 1 * component name standardization pt 2 * standardization pt 3 * standardize component names pt 4 * peer review * fix lnk * update edit tool actions section * standardize Agent, agent, agentic * more style auditing * missing imports
3 participants
The style rules are:
**Web Search** component, **Data** components, or **Google** bundle.[**<NAME>** component](link-to-component). Don't put the word "component" outside the link.Summary by CodeRabbit