Repository navigation
feat(develop-docs): Render span attributes from sentry-conventions - #20557
Closed
sentry-junior[bot] wants to merge 6 commits into
Closed
sentry-junior[bot] wants to merge 6 commits into
sentry-junior[bot] wants to merge 6 commits into
Conversation
Add a ConventionAttributes MDX component that reads attribute type, description, deprecation, and example from @sentry/conventions instead of copying them into Markdown tables. Unknown keys fail the build. Migrate the token usage and execute tool tables on the AI agents page.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Keep the table close to the Markdown tables it replaces. Drop the per-key links, the deprecated prefix, and the InlineMarkdown wrapper, and shorten the unknown-attribute error. Add one link under each table to the attribute category page in Sentry Conventions instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
Author
Preview: Token Usage Data table
After ( Before (hand-written Markdown table on develop.sentry.dev): Differences reviewers will notice:
|
Contributor
Author
Preview: Execute Tool Span table
After ( Before (hand-written Markdown table on develop.sentry.dev): Differences reviewers will notice:
|
…ttributes-component # Conflicts: # develop-docs/sdk/telemetry/traces/modules/ai-agents.mdx
Replace the hand-written notes prop with the additionalContext notes from @sentry/conventions. Notes render as a numbered list under the table, and attributes that share a note link to the same number, so pages no longer maintain footnotes for attributes the component renders.
dingsdax
marked this pull request as ready for review
November 6, 2026 08:58
Contributor
|
Getting ready to monitor this change · Rollout details
|
Contributor
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 23302c9. Configure here.
…butes String examples were wrapped in raw double quotes, so JSON strings such as gen_ai.tool.call.arguments rendered as broken nested quotes. Single-quote strings that contain double quotes, matching the Markdown tables, and use JSON.stringify for everything else.
1 of 6 tasks
Member
|
replaced by #20638 |
cleptric
added a commit
that referenced
this pull request
Nov 10, 2026
…20638) ## DESCRIBE YOUR PR Replaces #20557. Adds a `<ConventionAttributes>` MDX component that renders span attribute tables straight from [`@sentry/conventions`](https://github.com/getsentry/sentry-conventions), so the develop docs stop drifting from the conventions repo. The AI agents module page is the first user. - New `ConventionAttributes` component (with tests), registered in `mdxComponents.ts` - All attribute tables on the AI agents page now render from conventions; footnotes the convention briefs already cover are dropped - Depends on `@sentry/conventions@^0.33.0`, which ships getsentry/sentry-conventions#784 through #788 Preview: https://develop-docs-git-cleptric-featconvention-attributes-component.sentry.dev/sdk/telemetry/traces/modules/ai-agents/ ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. Select exactly one option. For deadlines, replace `YYYY-MM-DD` with the due date. You can update this information later by editing the PR description. - [ ] Urgent deadline (GA date, etc.): YYYY-MM-DD - [ ] Other deadline: YYYY-MM-DD - [x] No deadline: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've supplied a deadline. Thanks in advance for your help! ## PRE-MERGE CHECKLIST _Make sure you've checked the following before merging your changes:_ - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com> Co-authored-by: Johannes Daxböck <johannes.daxboeck@sentry.io> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This branch was successfully deployed
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
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.





DESCRIBE YOUR PR
Render develop-docs attribute tables from
@sentry/conventionsinstead of copying them, so type, description, and example can't drift from the source of truth.@sentry/conventionsdependency<ConventionAttributes>MDX component (Attribute / Type / Description / Example), with a link to the attribute category in Sentry Conventions under each tablenotesfor page-specific footnotesai-agents.mdxNote: descriptions now come from conventions, so wording fixes go upstream (e.g. the
gen_ai.usage.total_tokenstypo).IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace
YYYY-MM-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
🤖 Generated with Claude Code