docs: update tracing#979
Merged
Merged
Conversation
|
This comment has been minimized.
This comment has been minimized.
Contributor
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. 📝 WalkthroughWalkthroughThe pull request restructures observability tracing documentation by removing concept.md, revising overview.md, and adding five new tracing documentation pages (waterfall, node-based, logs, feedback, users). A new React MediaPanel component is introduced. Navigation is updated in the sidebar. A new blog post on Agent Middleware is added. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
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 |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
1 issue found across 5 files
Prompt for AI agents (all issues)
Check if these issues are valid — if so, understand the root cause of each and fix them.
<file name="website/observability/tracing/overview.md">
<violation number="1" location="website/observability/tracing/overview.md:34">
P2: Close the admonition with an unindented `:::` so the tip block is properly terminated.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Fix all issues with AI agents
In `@website/observability/tracing/overview.md`:
- Around line 28-34: The closing admonition marker is indented which can prevent
the tip block from terminating; locate the tip block that starts with ":::tip"
and move the closing " :::" marker to the very start of its own line (no leading
spaces) so the admonition closes correctly, ensuring the tip content lines
remain indented but the final "::: " is unindented.
In `@website/observability/tracing/users.md`:
- Around line 18-44: The document has heading level jumps (e.g., "Key Metrics",
"User Feedback", and "Conversations" are "###") that should increment by one
from the previous heading to satisfy linting; update these headings ("Key
Metrics", "User Feedback", "Conversations") to the correct level (e.g., change
"###" to "##" or to whatever level follows the preceding heading) so the outline
increments properly and heading nesting is consistent.
- Around line 22-50: Replace the raw HTML <img> tags (the elements whose src
include "tracing-charts.gif" and "tracing-feedback.gif") with proper Markdown
image syntax or a referenced image link to satisfy MD034, and update each alt
attribute to a descriptive, accessible string (e.g., "Tracing charts showing
filters and metrics over time" and "User feedback sentiment and score clusters
over time") so the images convey their content; keep the existing conversation
image (the ![conversation] entry) but also improve its alt text to something
like "Conversation view showing session cards and filtered traces" for
consistency.
In `@website/observability/tracing/views.md`:
- Around line 54-57: Update the <img> element showing the feedback GIF to avoid
the MD034 raw URL lint warning and make the alt text specific to the Feedback
panel: either convert the HTML <img> into Markdown image syntax using the given
src URL or add a per-line rule suppression for MD034, and change the alt
attribute value to something descriptive like "Feedback panel trace filters GIF"
(edit the
src="https://cdn.voltagent.dev/docs/observability/tracing/feedback.gif" <img>
element and its alt attribute).
🧹 Nitpick comments (1)
website/observability/tracing/overview.md (1)
22-22: Prefer a relative doc link for portability.Absolute links can break in local previews or alternate base URLs; a relative path keeps navigation consistent.
🔧 Suggested change
-When you select a trace from the list, you can open its [detailed views](https://voltagent.dev/observability-docs/tracing/views/). +When you select a trace from the list, you can open its [detailed views](./views).
Deploying voltagent with
|
| Latest commit: |
2178fae
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://e8407eed.voltagent.pages.dev |
| Branch Preview URL: | https://update-observability-docs.voltagent.pages.dev |
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
…s and feedback sections
…ent/voltagent into update-observability-docs
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@website/blog/2026-01-20-agent-middleware/index.md`:
- Line 97: Replace the bare URL on the line "Read the full docs and API details
here: https://voltagent.dev/docs/agents/middleware" with a proper Markdown link
by wrapping the URL in link syntax (for example: "Read the full docs and API
details here: [Voltagent Agents Middleware
Docs](https://voltagent.dev/docs/agents/middleware)") to satisfy MD034; edit the
paragraph text in the blog post to use that link.
- Line 20: Update the sentence that reads "Agent middleware is a pre and post
processing layer..." to use the hyphenated compound modifier form "pre- and
post-processing" so it reads "Agent middleware is a pre- and post-processing
layer that runs before guardrails and hooks on each agent call." This fixes the
grammar in the paragraph describing Agent middleware.
- Line 49: Update the phrase "Block unsafe or out of policy replies" to
hyphenate the compound adjective—change it to "Block unsafe or out-of-policy
replies" wherever that exact heading/string appears (e.g., the line containing
"Block unsafe or out of policy replies") to follow correct grammar for compound
adjectives.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Checklist
Please check if your PR fulfills the following requirements:
Bugs / Features
What is the current behavior?
What is the new behavior?
fixes (issue)
Notes for reviewers
Summary by cubic
Updated Tracing docs with new views (Waterfall, Node-Based, Logs, Feedback) and User Analytics, a streamlined overview with filter guidance, and cleaned navigation. Improves trace debugging and user impact analysis.
New Features
Refactors
Written for commit 2178fae. Summary will update on new commits.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.