Skip to content

docs(agent-tracing): Update GenAI conventions - #19509

Merged
obostjancic merged 5 commits into
masterfrom
docs/genai-convention-normalization
Sep 22, 2026
Merged

obostjancic merged 5 commits into
masterfrom
docs/genai-convention-normalization

Conversation

@obostjancic

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

The SDK Agent Tracing convention now documents current message-part shapes, including reasoning and tool-call parts, and uses the canonical cached-input and reasoning-output token attributes. RFC 2119 requirement keywords are formatted consistently.

Agent and pipeline names remain requirements for execute-tool spans but are not repeated in the tool-specific data table.

Split from #19461 so the developer-docs build and product-docs build run in separate PRs and do not overwrite each other's .next output.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

Update the SDK convention reference with current message-part shapes, requirement keyword formatting, and canonical cached and reasoning token attributes. Keep general agent and pipeline requirements out of the tool-data table.
@vercel

vercel Bot commented Sep 18, 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 Sep 22, 2026 9:58am UTC
sentry-docs Ready Ready Preview Sep 22, 2026 9:58am UTC

Request Review

@github-actions github-actions Bot added Priority: Normal Docs review has no urgent deadline sdk-develop-docs PRs touching develop-docs/sdk labels Sep 18, 2026
@obostjancic obostjancic changed the title docs(agent-tracing): Normalize GenAI conventions docs(agent-tracing): Update GenAI conventions Sep 18, 2026
@obostjancic
obostjancic requested a review from a team September 18, 2026 11:32
@obostjancic
obostjancic marked this pull request as ready for review September 18, 2026 11:32
Describe reasoning parts by their rendered behavior without treating Conversations view as a formal UI name.
@obostjancic
obostjancic merged commit f146655 into master Sep 22, 2026
22 checks passed
@obostjancic
obostjancic deleted the docs/genai-convention-normalization branch September 22, 2026 09:58
sfanahata added a commit that referenced this pull request Oct 8, 2026
## DESCRIBE YOUR PR

`pnpm build` and `pnpm build:developer-docs` both write to `.next`. When
a PR touches both `docs/**` and `develop-docs/**`, the 404 workflow runs
both builds in one job and then starts one server. By then the developer
docs build has overwritten the docs build, so only developer docs get
checked for broken links.

This change gives each changed site its own job and runner:

- A `changes` job decides which sites changed.
- One `Lint <site> for 404s` job runs per changed site, in parallel.
Each job builds, starts the server, and runs the linter. The runner is
thrown away when the job ends, so the server doesn't need to be stopped
and nothing else shares port 3000.
- A small `lint-404` job keeps the required check name. It passes when
every changed site passes its lint, or when no site changed.

Changes to this workflow or `scripts/lint-404s/**` now lint both sites,
so edits to the workflow check themselves.

An earlier version of this PR handled the shared build with a bash
script that started and stopped the server between sites. Separate jobs
remove the need for it. PRs that touch both sites also run the two
builds in parallel instead of one after the other.

Replaces #19465. That PR's other changes already landed in #19509 (AI
Agents doc) and #19526 (cross-site link handling).

## IS YOUR CHANGE URGENT?

- [ ] Urgent deadline (GA date, etc.): YYYY-MM-DD
- [ ] Other deadline: YYYY-MM-DD
- [x] No deadline: Not urgent, can wait up to 1 week+

## PRE-MERGE CHECKLIST

- [ ] 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)

<!-- junior-request-attribution:start -->
via **shannon.anahata**.
<!-- junior-request-attribution:end -->

<!-- junior-session-footer:start -->
<!-- junior-conversation-id:slack%3AD0BB8KQT6MU%3A1791324850.904489 -->

--

[View Junior
Session](https://junior-prod.sentry.dev/conversations/slack%3AD0BB8KQT6MU%3A1791324850.904489)
[[Sentry]](https://sentry.sentry.io/explore/conversations/slack%3AD0BB8KQT6MU%3A1791324850.904489/?project=4510944073809921)

<!-- junior-session-footer:end -->

---------

Co-authored-by: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com>
Co-authored-by: Shannon Anahata <shannon.anahata@sentry.io>

This branch was successfully deployed

2 active deployments
Preview – sentry-docs — a476c0d4 Deployed Sep 22, 2026 by vercel[bot]
Preview – develop-docs — a476c0d4 Deployed Sep 22, 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.

2 participants