docs: agents tutorial#8961
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 WalkthroughA new tutorial document was added, guiding users on connecting a JavaScript application to a Langflow agent, including flow setup and API interaction. The sidebar configuration was updated to include this tutorial under a new "Tutorials" section within the "Get started" category. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant JavaScript App
participant Langflow API
participant Langflow Agent
User->>JavaScript App: Provides email input
JavaScript App->>Langflow API: POST request with email as input
Langflow API->>Langflow Agent: Passes input to agentic flow
Langflow Agent->>Langflow API: Returns agent output (e.g., recommended items/URLs)
Langflow API->>JavaScript App: Sends agent response
JavaScript App->>User: Displays extracted URLs or recommendations
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
|
dosubot
Bot
added
size:L
github-actions
Bot
added
documentation
This comment was marked as outdated.
This comment was marked as outdated.
github-actions
Bot
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (3)
docs/docs/Tutorials/agent.md (3)
57-60: Bullet style violates markdown-lint rule MD004.Switch
*to-to stay consistent with the docs linter configuration.- * `LANGFLOW_SERVER_ADDRESS`: Your Langflow server's domain. The default value is `127.0.0.1:7860`. You can get this value from the code snippets on your flow's [**API access** pane](/concepts-publish#api-pane). - * `FLOW_ID`: Your flow's UUID or custom endpoint name. You can get this value from the code snippets on your flow's [**API access** pane](/concepts-publish#api-pane). - * `LANGFLOW_API_KEY`: A valid Langflow API key. To create an API key, see [API keys](/configuration-api-keys). + - `LANGFLOW_SERVER_ADDRESS`: Your Langflow server's domain. The default value is `127.0.0.1:7860`. You can copy this from the code snippets on your flow’s **API access** pane. + - `FLOW_ID`: Your flow’s UUID or custom endpoint name (also in the **API access** pane). + - `LANGFLOW_API_KEY`: A valid Langflow API key. Create one in **Configuration → API keys**.
113-118: Code block missing language identifier (MD040).Add
text(orconsole) so syntax highlighting isn’t triggered incorrectly.-``` +```text URLs found: https://www.facebook.com/marketplace/108225782538164/electronics/ https://www.facebook.com/marketplace/108944152458332/furniture/ https://www.facebook.com/marketplace/137493719613732/kitchen-cabinets/--- `153-154`: **Typo: “Which ever” → “Whichever”.** ```diff - Which ever approach you choose, your application receives three URLs for recommended used items based on a customer's previous orders in your local CSV, all without changing any code. + Whichever approach you choose, your application receives three URLs for recommended used items based on a customer’s previous orders in your local CSV—all without changing any application code.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
docs/static/files/customer_orders/customer_orders.csvis excluded by!**/*.csvdocs/static/img/tutorial-agent-with-directory.pngis excluded by!**/*.png
📒 Files selected for processing (2)
docs/docs/Tutorials/agent.md(1 hunks)docs/sidebars.js(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
`docs/sidebars.js`: Sidebar navigation must be configured and updated in 'docs/sidebars.js' to reflect the current documentation structure.
docs/sidebars.js: Sidebar navigation must be configured and updated in 'docs/sidebars.js' to reflect the current documentation structure.
📄 Source: CodeRabbit Inference Engine (.cursor/rules/docs_development.mdc)
List of files the instruction was applied to:
docs/sidebars.js
`docs/docs/**/*.{md,mdx}`: All documentation content must be placed within the '...
docs/docs/**/*.{md,mdx}: All documentation content must be placed within the 'docs/' directory, organized into subdirectories such as 'getting-started', 'components', 'integrations', 'administration', 'contributing', and 'api-reference'.
All documentation markdown files must start with a frontmatter block containing at least 'title' and 'description' fields.
Use admonitions (:::tip, :::warning, :::danger) in markdown files to highlight important information, warnings, or critical issues.
Reference images in documentation using the '/img/' path and provide descriptive alt text in markdown.
Use code blocks with language identifiers and optional titles for code examples in markdown documentation.
Documentation 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', and 'Flow' when referring to Langflow concepts; always uppercase 'API' and 'JSON'.
📄 Source: CodeRabbit Inference Engine (.cursor/rules/docs_development.mdc)
List of files the instruction was applied to:
docs/docs/Tutorials/agent.md
🧠 Learnings (3)
📓 Common learnings
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: When writing documentation for Langflow using Docusaurus, always use professional but approachable tone, second person voice for instructions, and present tense for current features.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: All terminology such as 'Langflow', 'Component', 'Flow', 'API', and 'JSON' must be capitalized or uppercased as specified in the terminology section.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-30T14:40:02.682Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize 'Langflow', 'Component', and 'Flow' when referring to Langflow concepts; always uppercase 'API' and 'JSON'.
docs/sidebars.js (2)
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-30T14:40:02.682Z
Learning: Applies to docs/sidebars.js : Sidebar navigation must be configured and updated in 'docs/sidebars.js' to reflect the current documentation structure.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: Sidebar and navigation should be kept current to ensure users can easily find all documentation sections and cross-references.
docs/docs/Tutorials/agent.md (2)
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: When writing documentation for Langflow using Docusaurus, always use professional but approachable tone, second person voice for instructions, and present tense for current features.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-30T14:40:02.682Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize 'Langflow', 'Component', and 'Flow' when referring to Langflow concepts; always uppercase 'API' and 'JSON'.
🪛 markdownlint-cli2 (0.17.2)
docs/docs/Tutorials/agent.md
57-57: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
58-58: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
59-59: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
113-113: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
113-113: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
132-132: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
⏰ 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 (1)
docs/sidebars.js (1)
10-16: Tutorial is discoverable—good addition.The nested “Tutorials” category and reference to
"Tutorials/agent"are wired correctly, so the new doc will appear under Get started → Tutorials.
No structural or naming issues spotted here.
github-actions
Bot
added
documentation
This comment was marked as outdated.
This comment was marked as outdated.
github-actions
Bot
added
documentation
|
Build successful! ✅ |
This comment was marked as outdated.
This comment was marked as outdated.
github-actions
Bot
added
documentation
|
Build successful! ✅ |
aimurphy
left a comment
aimurphy
left a comment
There was a problem hiding this comment.
2 small comments, otherwise good to go
github-actions
Bot
added
documentation
|
Build successful! ✅ |
melienherrera
left a comment
melienherrera
left a comment
There was a problem hiding this comment.
+1 Thank you for the changes. LGTM
github-merge-queue
Bot
removed this pull request from the merge queue due to a conflict with the base branch
github-actions
Bot
added
documentation
|
Build successful! ✅ |
4 participants
Preview build
Add a tutorial for connecting a JS application to an Agent.
Summary by CodeRabbit