docs(examples): remove dead link to removed sdk-trace-example - #1408
docs(examples): remove dead link to removed sdk-trace-example#1408feizhuzheng wants to merge 1 commit into
Conversation
The examples index still lists an `SDK Trace Example` entry linking to `./sdk-trace-example`, but that example directory was deleted in 5aa84b5 (feat: add evals, VoltAgent#674) and now 404s on GitHub. No replacement example exists, so remove the stale entry.
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review. 📝 WalkthroughWalkthroughThe examples README removes the ChangesExamples documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This docs-only change removes a link to an example that no longer exists; no actionable merge-blocking risk remains after normal checks and review. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Description checkExplanation The description explains the current and new behavior, identifies the deleted directory, documents verification, and notes why tests and a changeset are not included. The checklist remains unchecked and no related issue is linked, but the description is otherwise complete and directly related to the change. Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
What is the current behavior?
The examples index (
examples/README.md) lists an SDK Trace Example entry:But
examples/sdk-trace-example/no longer exists. It was deleted in commit5aa84b5b(feat: add evals, #674), which removed all of its files (src/index.ts,README.md,.env.example,tsconfig.json,.gitignore). The relative link therefore 404s on GitHub, and there is no replacement example directory that covers OpenTelemetry tracing (searched all 87 example dirs — none match trace/observability/otel).What is the new behavior?
Remove the stale entry so the examples index only points at examples that actually exist. One-line deletion, no other entries touched.
Verification
curlofcontents/examples/sdk-trace-exampleonmainreturns 404.examples/README.md(every other./…entry resolves to an existing directory).Notes for reviewers
There is one more stale reference to the same removed example in a dated blog post (
website/blog/2025-10-21-ai-agent-examples/index.md, links to.../tree/main/examples/sdk-trace-example). I left the blog untouched since it is point-in-time content — happy to update it too if you'd prefer.Docs-only change (examples index), so no changeset or tests.
Summary by cubic
Removes the dead SDK Trace Example entry from the examples index, since
examples/sdk-trace-example/was deleted and the link now 404s on GitHub.Written for commit 5e1b6c0. Summary will update on new commits.
Summary by CodeRabbit