Skip to content

docs(examples): remove dead link to removed sdk-trace-example - #1408

Open
feizhuzheng wants to merge 1 commit into
VoltAgent:mainfrom
feizhuzheng:docs/remove-dead-sdk-trace-example-link
Open

docs(examples): remove dead link to removed sdk-trace-example#1408
feizhuzheng wants to merge 1 commit into
VoltAgent:mainfrom
feizhuzheng:docs/remove-dead-sdk-trace-example-link

Conversation

@feizhuzheng

@feizhuzheng feizhuzheng commented Aug 28, 2026

Copy link
Copy Markdown

What is the current behavior?

The examples index (examples/README.md) lists an SDK Trace Example entry:

- [SDK Trace Example](./sdk-trace-example) — OpenTelemetry tracing wired to VoltOps so you can inspect spans and events.

But examples/sdk-trace-example/ no longer exists. It was deleted in commit 5aa84b5b (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

  • curl of contents/examples/sdk-trace-example on main returns 404.
  • The removed line is the only broken relative link in 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.

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Removed the SDK Trace Example from the list of available examples.

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.
@changeset-bot

changeset-bot Bot commented Aug 28, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 5e1b6c0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 1d780955-83bd-4650-8adc-b39104ac0649

📥 Commits

Reviewing files that changed from the base of the PR and between 44b4c8e and 5e1b6c0.

📒 Files selected for processing (1)
  • examples/README.md
💤 Files with no reviewable changes (1)
  • examples/README.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The examples README removes the SDK Trace Example entry from the “All Examples” list.

Changes

Examples documentation

Layer / File(s) Summary
Remove SDK Trace listing
examples/README.md
The “All Examples” list no longer includes ./sdk-trace-example.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 5e1b6

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)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely identifies the documentation change: removing a dead link to the deleted SDK Trace Example.
Description check ✅ Passed 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 a…
Docstring Coverage ✅ Passed 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…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

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 Coverage

Explanation

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)
  • Create PR with 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Re-trigger cubic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant