Skip to content

feat(develop-docs): Render span attributes from sentry-conventions - #20638

Merged
cleptric merged 10 commits into
masterfrom
cleptric/feat/convention-attributes-component
Nov 10, 2026
Merged

cleptric merged 10 commits into
masterfrom
cleptric/feat/convention-attributes-component

Conversation

@cleptric

@cleptric cleptric commented Nov 9, 2026 •

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Replaces #20557.

Adds a <ConventionAttributes> MDX component that renders span attribute tables straight from @sentry/conventions, so the develop docs stop drifting from the conventions repo. The AI agents module page is the first user.

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
  • 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

🤖 Generated with Claude Code

AGT-3145

@vercel

vercel Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
develop-docs Ready Ready Preview Nov 10, 2026 4:08pm UTC
sentry-docs Ready Ready Preview Nov 10, 2026 4:08pm UTC

Request Review

@github-actions github-actions Bot added sdk-develop-docs PRs touching develop-docs/sdk Priority: Needs Triage The PR description is missing valid priority information labels Nov 9, 2026
@cleptric
cleptric force-pushed the cleptric/feat/convention-attributes-component branch from cbfc412 to 4d2be3b Compare November 9, 2026 11:44
sentry-junior Bot and others added 10 commits November 10, 2026 17:01
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.
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>
…ions

Migrate the request data, response data, and embedding span tables on
the AI agents page to ConventionAttributes, so every attribute table on
the page reads from @sentry/conventions.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Drop the per-table link to Sentry Conventions, since every table on a
page repeated it. Let the description column wrap, because the site
table styles keep every column but the last on one line and convention
briefs are long. Single-quote stringified JSON examples, matching the
tables this replaces, and reject keys inherited from Object.prototype.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The gen_ai.input.messages brief now describes the parts message shape.
Both message briefs say the value must be stringified, so drop the [0]
footnote from those rows.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The gen_ai message and tool definition briefs in sentry-conventions now
cover the stringified value requirement and the parts message shape,
including reasoning parts. Remove the footnotes that repeated them and
renumber the remaining one.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Install @sentry/conventions from a tarball built at sentry-conventions
28c06d3e, which includes the message and tool definition brief fixes
from getsentry/sentry-conventions#784 and #785. Temporary until those
changes ship in an npm release.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Pick up getsentry/sentry-conventions#786, #787, and #788. The
reasoning level brief now says supported values vary by provider, so
drop the page-specific note.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The footnote was only referenced once, so move its text into the span
name bullet.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
0.33.0 ships getsentry/sentry-conventions#784 through #788, so the
vendored tarball is no longer needed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cleptric
cleptric force-pushed the cleptric/feat/convention-attributes-component branch from 66156a3 to 8c164b3 Compare November 10, 2026 16:02
@cleptric
cleptric marked this pull request as ready for review November 10, 2026 16:02
@codeowner-assignment
codeowner-assignment Bot requested a review from a team November 10, 2026 16:02
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-10T16:04:23.428463Z 8c164b3 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions github-actions Bot added Priority: Normal Docs review has no urgent deadline and removed Priority: Needs Triage The PR description is missing valid priority information labels Nov 10, 2026
@cursor

cursor Bot commented Nov 10, 2026

Copy link
Copy Markdown
Contributor

Getting ready to monitor this change · Rollout details

Status Service Environment
⏳ Getting ready to monitor this change

@cursor cursor 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.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 8c164b3. Configure here.

}
const description = micromark([attribute.brief, notes].filter(Boolean).join(' '))
.replace(/^<p>/, '')
.replace(/<\/p>$/, '');

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.

Paragraph unwrap breaks multi-block briefs

Medium Severity

micromark output is unwrapped by stripping a leading <p> and a trailing </p> independently. That only works for a single paragraph. Multi-paragraph brief text, or brief plus notes that form more than one block, leaves mismatched tags inside the cell via dangerouslySetInnerHTML, so later paragraphs pick up prose margins and the description renders inconsistently.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 8c164b3. Configure here.

@cleptric
cleptric merged commit ebcdb4c into master Nov 10, 2026
35 of 37 checks passed
@cleptric
cleptric deleted the cleptric/feat/convention-attributes-component branch November 10, 2026 16:11
@linear-code

linear-code Bot commented Nov 10, 2026

Copy link
Copy Markdown

AGT-3145

This branch was successfully deployed

2 active deployments
Preview – sentry-docs — 8c164b3b Deployed Nov 10, 2026 by vercel[bot]
Preview – develop-docs — 8c164b3b Deployed Nov 10, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants