docs: refresh quickstart

[mendonk]

Quickstart preview build
Rewrite quickstart to "Run Simple agent in Langflow IDE -> expose as API endpoint -> run it with a python or js application".

TODO:

More info on output schema (done)
Add a little more info on how flows run, and message types
Add MCP server to more options (done)

Summary by CodeRabbit

• Documentation
  • Updated the prompts component documentation to reference the "Vector RAG starter flow" and replaced the illustrative image accordingly.
  • Overhauled the quickstart guide to focus on using the Simple Agent template flow and interacting with it via the API, including new code examples in Python, JavaScript, and curl.
  • Added interactive terminal chat examples and clarified API payload structure, while removing previous step-by-step build instructions and Astra DB RAG integration details.

[coderabbitai]

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

The documentation was updated to shift the "Get Started" guide from building a basic chatbot flow to running a pre-built "Simple Agent" template via the Langflow API, with new code examples and API usage details. The prompt component documentation was also revised to reference the "Vector RAG starter flow" instead of the previous quickstart guide.

Changes

File(s)	Change Summary
docs/docs/Get-Started/get-started-quickstart.md	Rewrote guide to focus on running the Simple Agent template via API, added multi-language code samples, removed step-by-step flow building and vector RAG extension sections.
docs/docs/Components/components-prompts.md	Updated example and image to reference "Vector RAG starter flow" instead of the quickstart guide.

Suggested labels

documentation, size:L, lgtm

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch docs-quickstart-refresh

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• 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 src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

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.

Documentation and Community

• 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]

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (5)

docs/docs/Get-Started/get-started-quickstart.md (5)

41-41: Refine optional continuation wording
Consider a more engaging call-to-action, e.g.:

“If you’d rather stay in the Langflow UI and build more flows, feel free to stop here.”

---

54-55: Consistent groupId naming
You have two separate <Tabs> blocks with groupId="Language" and groupId="Languages". For clarity, use consistent naming or lowercase (e.g., groupId="language-chat") across both blocks.

---

57-86: Add a timeout to Python example
Prevent indefinite hangs by specifying a timeout in the request:

- response = requests.request("POST", url, json=payload, headers=headers)
+ response = requests.post(url, json=payload, headers=headers, timeout=10)

---

91-111: Validate JS response status before parsing
Add a check for response.ok to handle non-2xx statuses explicitly:

- fetch(url, options)
-    .then(response => response.json())
+ fetch(url, options)
+    .then(response => {
+        if (!response.ok) throw new Error(`HTTP ${response.status}`);
+        return response.json();
+    })

---

118-125: Replace hard tabs and add --fail to curl
Markdown lint flags hard tabs. Also include --fail so curl exits non-zero on HTTP errors:

-	curl --request POST \
-	     --url 'http://localhost:7860/api/v1/run/...?stream=false' \
-	     --header 'Content-Type: application/json' \
-	     --data '{
-		       "output_type": "chat",
-		       "input_type": "chat",
-		       "input_value": "hello world!"
-		     }'
+	curl --fail --request POST \
+	     --url 'http://localhost:7860/api/v1/run/...?stream=false' \
+	     --header 'Content-Type: application/json' \
+	     --data '{
+	         "output_type": "chat",
+	         "input_type": "chat",
+	         "input_value": "hello world!"
+	     }'

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1950116 and 42ea31d.

⛔ Files ignored due to path filters (2)

• docs/static/img/quickstart-simple-agent-playground.png is excluded by !**/*.png
• docs/static/img/starter-flow-simple-agent.png is excluded by !**/*.png

📒 Files selected for processing (2)

• docs/docs/Components/components-prompts.md (1 hunks)
• docs/docs/Get-Started/get-started-quickstart.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/docs/Get-Started/get-started-quickstart.md

[style] ~43-~43: Consider using an alternative to strengthen your wording.
Context: ...ate more flows within Langflow. If you want to learn how Langflow integrates into e...

(WANT_KEEN)

🪛 markdownlint-cli2 (0.17.2)

docs/docs/Get-Started/get-started-quickstart.md

122-122: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

123-123: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

124-124: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

125-125: Hard tabs
Column: 1

(MD010, no-hard-tabs)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build-and-deploy

🔇 Additional comments (6)

docs/docs/Get-Started/get-started-quickstart.md (4)

7-8: Confirm MDX tab imports
The <Tabs> and <TabItem> imports enable tabbed code examples in MDX. Ensure your Docusaurus theme is configured to support @theme/Tabs and @theme/TabItem.

---

10-10: Clear introduction to quickstart workflow
The opening line succinctly outlines loading, running, and exposing a flow via the /run endpoint.

---

17-19: Well-structured agent template section
The new “Run the agent template flow” heading and accompanying instructions are clear and actionable for users.

---

31-34: Illustrative Playground screenshot
The image and description effectively show the agent invoking the Calculator component. Good visual reinforcement.

docs/docs/Components/components-prompts.md (2)

16-16: Verify the updated reference link
Please confirm that /starter-projects-vector-store-rag matches the actual slug of the “Vector RAG starter flow” page.

---

18-18: Update alt text for new image
The new image better illustrates a vector RAG pipeline. The alt text is accurate and descriptive.

[aimurphy]

This was super informative and useful. I left my feedback as I went through and encountered questions at each step.

[erichare]

Looks fantastic as far as i can tell @mendonk . i left a couple NIT comments but nothing stopping approval.

[github-actions]

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

[github-actions]

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