docs(sdk): add spec format components and migrate check-ins#16461
Merged
stephanie-anderson merged 14 commits intomasterfrom Feb 19, 2026
Merged
docs(sdk): add spec format components and migrate check-ins#16461stephanie-anderson merged 14 commits intomasterfrom
stephanie-anderson merged 14 commits intomasterfrom
Conversation
Introduce reusable MDX components for SDK spec pages: - SpecMeta: displays spec status and version with changelog link - SpecSection: wraps spec content with status badge and colored border - SpecChangelog: renders version history table from frontmatter - SpecRfcAlert: reusable RFC 2119 keyword notice Migrate check-ins spec to the new format with structured frontmatter (spec_id, spec_version, spec_status, spec_platforms, spec_depends_on, spec_changelog), RFC 2119 requirement keywords, and organized sections (Overview, Concepts, Behavior, Wire Format, Public API, Examples, Changelog). Update page.tsx to bind spec frontmatter data to components so MDX files use zero-prop tags like <SpecMeta /> and <SpecChangelog />. Co-Authored-By: Claude <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-Authored-By: Claude <noreply@anthropic.com>
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
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.
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Deduplicate the SpecStatus type and badge color mapping that was identical in specMeta.tsx and specSection.tsx into specConstants.ts. Co-Authored-By: Claude <noreply@anthropic.com>
Use a type guard to validate spec_status from frontmatter before passing it to SpecMeta. Invalid values now skip rendering the component instead of passing undefined badge classes. Co-Authored-By: Claude <noreply@anthropic.com>
Add dark: Tailwind variants to badge backgrounds/text and section border colors so they render with proper contrast in dark mode. Co-Authored-By: Claude <noreply@anthropic.com>
Skip entries missing version, date, or summary instead of rendering literal 'undefined' strings. Also skip rendering an empty changelog. Co-Authored-By: Claude <noreply@anthropic.com>
dingsdax
approved these changes
Feb 19, 2026
codyde
added a commit
that referenced
this pull request
Feb 19, 2026
* origin/master: docs(sdk): coordination and maintenance standards (#16463) docs(sdk): add spec format components and migrate check-ins (#16461) docs(sdk): repository and documentation standards (#16462) docs(sdk): Add issue saved replies and simplify CopyableCard (#16459) docs(sdk): add review & ci standard (#16458) fix(unity): correct lifecycle breadcrumbs docs (#16456) docs(sdk): add code quality standard (#16455) docs(sdk): migrate releases process to playbook and standard (#16447) docs(sdk): merge basics.mdx into overview.mdx (#16446) docs(sdk): remove old triaging process page (#16448) docs(dart): Update stacktrace info for the logging integration (#16401) docs(dart): Fix user attributes gated behind `sendDefaultPii` (#16407) feat(playstation): Add symbols documentation for dumps (#16454) feat(develop-docs): Restore Sentry Voice guidelines page (#16453) # Conflicts: # app/[[...path]]/page.tsx
This was referenced Feb 19, 2026
stephanie-anderson
added a commit
that referenced
this pull request
Feb 20, 2026
Migrate `develop-docs/sdk/telemetry/logs.mdx` to the standardized spec format established in #16461. - Add spec frontmatter with `spec_version: 1.15.0`, `spec_status: stable`, dependencies, and 16 changelog entries derived from git history - Restructure content into Overview > Concepts > Behavior > Wire Format > Public API > Examples > Changelog - Wrap features in 20 SpecSections with precise `since` values (e.g., `replay-association` since 1.8.0, `client-reports` since 1.13.0) - Add `Since` columns to wire format tables and inline `(since X.Y.Z)` annotations for mid-section additions - Move language-specific code examples to Examples section as "SDK API Usage" - Upgrade requirements language to RFC 2119 uppercase bold keywords Co-Authored-By: Claude <noreply@anthropic.com>
stephanie-anderson
added a commit
that referenced
this pull request
Feb 20, 2026
) Backfill 4 patch versions in the check-ins spec changelog derived from git history, and swap sidebar ordering so Telemetry appears before Features. - **check-ins.mdx**: Added patch versions 1.0.1, 1.2.1, 1.3.1, 1.4.1 for typo fixes, example updates, and wording clarifications - **telemetry/index.mdx**: sidebar_order 5 → 4 - **expected-features/index.mdx**: sidebar_order 4 → 5 Part of the ongoing SDK spec format migration ([design plan](https://github.com/getsentry/sentry-docs/blob/master/docs/plans/2026-02-19-sdk-spec-format-design.md), initial PR #16461). Co-Authored-By: Claude <noreply@anthropic.com>
stephanie-anderson
added a commit
that referenced
this pull request
Feb 20, 2026
Migrate `develop-docs/sdk/telemetry/metrics.mdx` to the standardized spec format established in #16461. - Add spec frontmatter with `spec_version: 2.5.0`, `spec_status: stable`, dependencies, and 9 changelog entries derived from git history - Restructure content into Overview > Concepts > Behavior > Wire Format > Public API > Examples > Changelog - Wrap features in SpecSections with precise `since` values (e.g., `replay-association` since 2.3.0, `buffering` since 2.0.0) - Add `Since` columns to wire format tables and inline `(since X.Y.Z)` annotations for mid-section additions - Move language-specific code examples to Examples section as "SDK API Usage" - Upgrade requirements language to RFC 2119 uppercase bold keywords Co-Authored-By: Claude <noreply@anthropic.com>
stephanie-anderson
added a commit
that referenced
this pull request
Feb 23, 2026
Migrate `sdk/telemetry/client-reports.mdx` to the new spec format established in #16461. - Add versioned frontmatter with 22-entry changelog derived from full git history - Restructure into standard spec sections with `SpecRfcAlert`, `SpecMeta`, `SpecSection`, `SpecChangelog` components - Consolidate network failure recording rules from `expected-features/index.mdx` into the client-reports spec as the single source of truth - Remove client report section from `envelope-items.mdx` (content now lives in client-reports wire format section) - Split network failure recording into per-status-code SpecSections with precise `since` versions - Add wire format section with payload tables including `Since` columns - Replace inline rules in expected-features with references to the client-reports spec Co-authored-by: Claude <noreply@anthropic.com>
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Add reusable MDX components for SDK spec pages and migrate the check-ins spec as the first example.
New components:
SpecMeta— displays spec status and version with changelog linkSpecSection— wraps spec content with status badge, colored left border, and "since" versionSpecChangelog— renders version history table from frontmatter dataSpecRfcAlert— reusable RFC 2119 keyword noticeCheck-ins migration:
spec_id,spec_version,spec_status,spec_platforms,spec_depends_on,spec_changelog<SpecMeta />,<SpecChangelog />)page.tsx changes:
MDXLayoutRenderernow creates frontmatter-bound component overrides for spec pagesCo-Authored-By: Claude noreply@anthropic.com