docs: merge starter projects and sample flows into templates#8652
Conversation
dosubot
Bot
added
the
size:M
|
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 update standardizes and simplifies documentation links and sidebar structure. It updates internal URLs, slugs, and redirect rules for several documentation files, consolidates sidebar categories into "Templates," and ensures consistent references across the documentation. No functional code or API behavior is affected; all changes are confined to documentation and configuration. Changes
Sequence Diagram(s)No sequence diagram generated as the changes are documentation and configuration updates only, with no control flow or feature logic affected. 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
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/docs/Components/components-tools.md (1)
22-22: Align link text with new Templates terminology
The URL is correct (/simple-agent), but consider updating the link label from “simple agent starter project” to “Simple agent template” to reflect the merged Templates section.docs/docs/Concepts/concepts-voice-mode.md (1)
22-22: Align terminology in voice mode guide
The link slug is correct, but update “Simple agent starter project” to “Simple agent template” to match the consolidated Templates naming.docs/docs/Integrations/mcp-component-astra.md (1)
20-20: Update terminology for template consistency
The link correctly points to/simple-agent. For consistency, consider replacing “Simple agent starter project” with “Simple agent template” in the instruction text.docs/docs/Integrations/Arize/integrations-arize.md (1)
70-70: Updated simple agent link slug
The link slug has been updated to/simple-agent, matching the new Templates routing. You may also want to replace “starter project” with “template” in the description to align with the unified naming.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (18)
docs/docs/API-Reference/api-reference-api-examples.md(1 hunks)docs/docs/Components/components-agents.md(1 hunks)docs/docs/Components/components-embedding-models.md(1 hunks)docs/docs/Components/components-logic.md(1 hunks)docs/docs/Components/components-models.md(3 hunks)docs/docs/Components/components-tools.md(1 hunks)docs/docs/Components/components-vector-stores.md(1 hunks)docs/docs/Concepts/concepts-voice-mode.md(1 hunks)docs/docs/Concepts/embedded-chat-widget.md(1 hunks)docs/docs/Get-Started/welcome-to-langflow.md(1 hunks)docs/docs/Integrations/Arize/integrations-arize.md(1 hunks)docs/docs/Integrations/mcp-component-astra.md(1 hunks)docs/docs/Templates/basic-prompting.md(1 hunks)docs/docs/Templates/memory-chatbot.md(1 hunks)docs/docs/Templates/simple-agent.md(1 hunks)docs/docs/Templates/vector-store-rag.md(1 hunks)docs/docusaurus.config.js(2 hunks)docs/sidebars.js(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/Components/components-models.md
[uncategorized] ~277-~277: Possible missing comma found.
Context: ...urity-tokens) to authenticate. In this example based on the [Basic prompting flow](/ba...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build-and-deploy
🔇 Additional comments (18)
docs/docs/Templates/simple-agent.md (1)
3-3: Updated slug to/simple-agent
The frontmatter slug has been correctly simplified by removing the/starter-projects-prefix to align with the consolidated Templates navigation.docs/docs/Templates/memory-chatbot.md (1)
12-12: Corrected link to Basic Prompting flow
The reference now points to/basic-prompting, matching the updated slug for the basic prompting template.docs/docs/Templates/vector-store-rag.md (1)
3-3: Updated slug to/vector-store-rag
The frontmatter slug has been simplified by dropping the/starter-projects-prefix, consistent with the new Templates grouping.docs/docs/Components/components-agents.md (1)
20-20: Revised link to Simple Agent starter project
The link correctly targets/simple-agent, reflecting the renamed slug in the Templates section.docs/docs/Templates/basic-prompting.md (1)
3-3: Updated slug to/basic-prompting
The frontmatter slug has been adjusted tobasic-prompting, removing the old/starter-projects-prefix for consistency.docs/docs/Get-Started/welcome-to-langflow.md (1)
26-26: Updated simple agent link slug
The link now points to/simple-agent, aligning with the consolidated Templates section and the new slug in your template front matter.docs/docs/Components/components-logic.md (1)
240-240: Confirm updated "Simple Agent" link slug
The link now points to/simple-agent. Please verify that the Simple Agent template page uses this slug in its frontmatter to avoid broken links.Use this script to check:
#!/bin/bash # Verify slug for Simple Agent template exists rg -n "^slug: /simple-agent" -n docsdocs/docs/Components/components-vector-stores.md (1)
84-84: Validate Vector Store RAG slug update
The example link references/vector-store-rag. Ensure the corresponding template file defines this slug so the link resolves correctly.#!/bin/bash # Verify slug for Vector Store RAG template exists rg -n "^slug: /vector-store-rag" -n docsdocs/docs/Concepts/embedded-chat-widget.md (1)
19-19: Verify Basic Prompting slug change
The link to the Basic prompting flow was updated to/basic-prompting. Confirm that the Basic Prompting page frontmatter matches this slug.#!/bin/bash # Verify slug for Basic Prompting flow exists rg -n "^slug: /basic-prompting" -n docsdocs/docs/Components/components-embedding-models.md (1)
283-283: Check Vector Store RAG link target
Updated the reference to/vector-store-rag. Please confirm that the Vector Store RAG template page defines this slug to prevent navigation errors.#!/bin/bash # Verify slug for Vector Store RAG template exists rg -n "^slug: /vector-store-rag" -n docsdocs/docs/API-Reference/api-reference-api-examples.md (1)
119-119: Confirm updated Basic Prompting example link
Link now correctly targets/basic-prompting, matching the consolidated slug after merging starter projects and sample flows.docs/docs/Components/components-models.md (4)
20-20: Confirm corrected Basic prompting flow link in models section
Updated to/basic-prompting, aligning with the new Templates slug and ensuring consistency.
230-230: Verify updated Basic prompting flow reference in Groq example
Link updated to/basic-prompting, reflecting the new URL structure for template flows.
277-277: Confirm corrected Basic prompting flow link in Hugging Face API example
Reference now uses/basic-prompting, consistent with the consolidated Templates naming.
279-279: Verify updated Basic prompting flow creation step
The link is correctly updated to/basic-promptingfor creating a Basic prompting flow.docs/sidebars.js (1)
14-24: Approve Templates category consolidation in sidebar
Starter projects and sample flows are merged under "Templates", with all items updated toTemplates/.... Ensure each referenced doc exists underdocs/docs/Templates/.docs/docusaurus.config.js (2)
203-210: LGTM! Redirect consolidation aligns with template restructuring.The change from
/math-agentto/simple-agentas the redirect target, along with adding/starter-projects-simple-agentto the sources, properly supports the consolidation of starter projects into the templates section.
272-279: New redirects properly handle URL structure changes.The addition of redirects for
/basic-promptingand/vector-store-ragcorrectly handles the removal of thestarter-projects-prefix, ensuring backward compatibility for existing links.Please verify that the target paths exist and are accessible:
#!/bin/bash # Verify that the redirect target paths exist in the documentation echo "Checking if redirect target paths exist..." # Check for basic-prompting content fd -t f "basic-prompting" docs/ # Check for vector-store-rag content fd -t f "vector-store-rag" docs/ # Also check for any references to these paths in markdown files echo "Checking for references to new paths..." rg -l "basic-prompting|vector-store-rag" docs/ --type md
|
Build successful! ✅ |
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
|
Build successful! ✅ |
…w-ai#8652) * move-pages-and-add-redirects * move-vector-rag-in-list
…w-ai#8652) * move-pages-and-add-redirects * move-vector-rag-in-list
2 participants
/starter-projects-slug and redirected where required.Summary by CodeRabbit
/basic-prompting,/simple-agent,/vector-store-rag) for improved consistency and clarity.