docs(sdk): migrate traces, spans, and hub/scope specs to standard format#16496
Draft
stephanie-anderson wants to merge 1 commit intomasterfrom
Draft
docs(sdk): migrate traces, spans, and hub/scope specs to standard format#16496stephanie-anderson wants to merge 1 commit intomasterfrom
stephanie-anderson wants to merge 1 commit intomasterfrom
Conversation
Apply spec format (versioning, SpecSection, changelogs) to traces/ (26 files), spans/ (consolidated into 1), and hub/scope (2 files). Create new Hub (deprecated) and Transactions (deprecated) specs. Restructure all specs to follow the standard Overview → Behavior → Wire Format → Public API → Changelog pattern. - Add spec metadata (spec_id, spec_version, spec_status, spec_changelog) to all files - Wrap requirement sections in SpecSection components with version tracking - Create sdk/foundations/data-model/hub.mdx (deprecated, superseded by scopes) - Create sdk/telemetry/transactions.mdx (deprecated, superseded by spans) - Rewrite traces/index.mdx as the Trace spec (trace-level concepts only) - Consolidate 8 spans/ subpages into spans/index.mdx - Fold distributed-tracing/ into traces/index.mdx - Add redirects for all moved/merged pages - Update all cross-references Co-Authored-By: Claude <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
1 participant
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
Apply spec format (versioning, SpecSection, changelogs) to the traces/, spans/, and hub/scope sections of the SDK developer docs. This is the largest batch in the spec format migration series.
Changes
New specs created:
sdk/foundations/data-model/hub.mdx— deprecated Hub spec (superseded by Scopes)sdk/telemetry/transactions.mdx— deprecated Transactions spec (superseded by Spans)Major rewrites:
traces/index.mdx— rewritten as the Trace spec (trace-level concepts only, transaction content extracted)spans/index.mdx— consolidated from 8 subpages into one comprehensive specscopes.mdx— transformed to v2.11.0 with deprecated v1 SpecSectionSpec format added to 31 existing files:
Structural changes:
distributed-tracing/folded into traces/index.mdx with redirectVersion derivation
Spec versions derived from git commit history analysis — each meaningful feature commit = minor bump, breaking changes = major bump, infrastructure commits skipped.
IS YOUR CHANGE URGENT?
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Co-Authored-By: Claude noreply@anthropic.com