Fixed Broken SDK Repo Link for Examples #16
Conversation
Updated the broken link for the SDK Repo for examples to the SRE Examples repo.
Update sdk-guide.mdx
WalkthroughA single documentation file updated a hyperlink target from the SDK repo path to the SRE Examples repo path. No other content or code was changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ 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. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
docs/agent-runtime/sdk-guide.mdx (1)
144-147: Update the “More Examples” link to /examplesThe docs/agent-runtime/sdk-guide.mdx still contains a stale link pointing to /packages/examples (update it to /examples). There is an earlier correct link at line 69 — only the later instance needs fixing.
- docs/agent-runtime/sdk-guide.mdx — line 146: update the link
- docs/agent-runtime/sdk-guide.mdx — line 69: already points to /examples (no change)
Apply this diff:
-Explore the [SDK examples folder](https://github.com/SmythOS/sre/tree/main/packages/examples) for advanced agent projects. +Explore the [SDK examples folder](https://github.com/SmythOS/sre/tree/main/examples) for advanced agent projects.
🧹 Nitpick comments (1)
docs/agent-runtime/sdk-guide.mdx (1)
8-10: Optional: Align naming (“SRE SDK” vs “SmythOS SDK”).Line 8 uses “SRE SDK” while Line 10 uses “SmythOS SDK”. Consider standardizing to a single name for clarity (e.g., “SmythOS SDK”).
Apply this diff if you prefer “SmythOS SDK” consistently:
-# Using SRE SDK to Build Agents +# Using the SmythOS SDK to Build Agents
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
💡 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 settings in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/agent-runtime/sdk-guide.mdx(1 hunks)
| @@ -66,7 +66,7 @@ const result = await agent.prompt('Tell me about SmythOS.'); | |||
| console.log(result); | |||
| ``` | |||
|
|
|||
| See more complete examples in the [SDK repo](https://github.com/SmythOS/sre/tree/main/packages/examples). | |||
| See more complete examples in the [SRE Examples repo](https://github.com/SmythOS/sre/tree/main/examples). | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Link target update looks good; verify existence and ensure all occurrences are updated.
The new URL points to the top-level examples directory, which aligns with the PR objective. Please verify the path exists in the target repo and that no other links still point to the old /packages/examples location.
Run this script to verify both the GitHub path and any remaining old links in the docs:
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "1) Check for remaining references to old path in docs:"
rg -n "github\.com/SmythOS/sre/tree/main/packages/examples" docs || echo "No old links found in docs."
echo
echo "2) Check for all references to the new path in docs (for consistency):"
rg -n "github\.com/SmythOS/sre/tree/main/examples" docs || echo "No new links found (only updated spot)."
echo
echo "3) Verify the new directory exists via GitHub API:"
NEW_URL="https://api.github.com/repos/SmythOS/sre/contents/examples"
OLD_URL="https://api.github.com/repos/SmythOS/sre/contents/packages/examples"
echo "New path status (expect 200):"
curl -s -o /dev/null -w "%{http_code}\n" "$NEW_URL"
echo "Old path status (expect 404 or 200 if still present):"
curl -s -o /dev/null -w "%{http_code}\n" "$OLD_URL"Length of output: 1397
Update remaining docs link to the new SRE examples path
Verified: the new path exists (GitHub API 200) and the old path returns 404. One remaining reference to the old URL was found — please update it.
- docs/agent-runtime/sdk-guide.mdx:146 — replace the old link
Replace:
Explore the SDK examples folder for advanced agent projects.
With:
Explore the SDK examples folder for advanced agent projects.
🤖 Prompt for AI Agents
docs/agent-runtime/sdk-guide.mdx around lines 69-69: update the outdated SRE
examples link found in the file (noted also at line 146) by replacing the old
URL https://github.com/SmythOS/sre/tree/main/packages/examples with the new URL
https://github.com/SmythOS/sre/tree/main/examples so the "Explore the [SDK
examples folder](...)" sentence points to the correct examples path.
The SDK Repo Link found on the https://smythos.com/docs/agent-runtime/sdk-guide/. I updated it to point to https://github.com/SmythOS/sre/tree/main/examples
Summary by CodeRabbit