Skip to content

docs(sdk): Document spec compliance manifests - #20076

Open
philprime wants to merge 2 commits into
masterfrom
docs/spec-compliance-manifest
Open

philprime wants to merge 2 commits into
masterfrom
docs/spec-compliance-manifest

Conversation

@philprime

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Introduce a shared sentry-spec-compliance.json convention so SDK maintainers can declare implemented specification versions, track section-level coverage, and explain sections that do not apply. The documentation explains full versus partial compliance, maintenance rules, and the initial format's inability to represent mixed-applicability sections.

Publish a JSON Schema Draft 2020-12 schema at https://develop.sentry.dev/schemas/spec-compliance.json, matching the URL referenced by Cocoa's manifest. It validates the declaration format, not implementation conformance. The schema URL becomes available when this change deploys.

IS YOUR CHANGE URGENT?

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

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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

@vercel

vercel Bot commented Oct 19, 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 Oct 19, 2026 12:13pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
sentry-docs Ignored Ignored Preview Oct 19, 2026 12:13pm UTC

Request Review

@github-actions github-actions Bot added sdk-develop-docs PRs touching develop-docs/sdk Priority: Normal Docs review has no urgent deadline labels Oct 19, 2026
@philprime
philprime marked this pull request as ready for review October 19, 2026 12:05
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 19, 2026 12:05
@cursor

cursor Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks new page loads, schema 404s, sibling page loads, and the client error rate. An issue escalates when schema 404s continue or those errors rise.

Services: develop-docs.

Mention @change-monitor in a comment to update the plan.

Plan

What changed

Requests to /sdk/getting-started/standards/spec-compliance/ now return the new manifest guide. Requests to /schemas/spec-compliance.json now return the JSON Schema document. The spec lifecycle page now links to that guide.

The develop-docs service must deploy before these URLs are live. The changed path, Vercel project, and Sentry project all match that service.

Risk

A broken MDX file can fail the new page or the edited lifecycle page. Readers who follow the new lifecycle link then hit a 404. Validators that already fetch the schema URL keep failing if the static file does not ship. Render failures can also appear as client errors during navigation in the standards section.

Intended effect

The new page must record loads. The schema URL must stop rendering the not-found page. Absent looks like sibling lifecycle loads continuing while the new page stays at zero, and schema 404s still firing.

Signal Baseline Window Rule Source
docs.page.load for /sdk/getting-started/standards/spec-compliance/ 0 loads 2026-10-17T12:06:25Z to 2026-10-19T12:06:25Z Rise above 0 Sentry org sentry, project develop-docs, metric docs.page.load, path:/sdk/getting-started/standards/spec-compliance/
docs.page.not_found for schemas/spec-compliance.json 1 event 2026-10-17T12:06:25Z to 2026-10-19T12:06:25Z Fall to 0 Sentry org sentry, project develop-docs, metric docs.page.not_found, requested_path:schemas/spec-compliance.json

The 7d window 2026-10-12T12:06:25Z to 2026-10-19T12:06:25Z also showed 1 schema 404. That path is already requested. After deploy those requests must not render not-found. Browsers already issued 3 sampled pageloads of https://develop.sentry.dev/schemas/spec-compliance.json in 7d.

Regression watch

Watch the edited lifecycle page, other standards pages, and client failures on that path family. At least one watch is a user-visible failure class.

Signal Baseline Window Rule Source
Production error rate 0.055-0.080% of classified requests 2026-10-12T12:06:25Z to 2026-10-19T12:06:25Z Hold in band. Escalate above 0.080% Sentry errors count(), project:develop-docs environment:production, over sum of docs.request.classified. 24h was 33/42985 (0.077%). 48h was 42/73184 (0.057%). 7d was 197/319956 (0.062%).
HTTP 5xx on /sdk/getting-started/* 0 spans 2026-10-17T12:06:25Z to 2026-10-19T12:06:25Z Hold at 0 Sentry spans project:develop-docs url.path:/sdk/getting-started/* http.response_status_code:>=500
docs.page.not_found for sdk/getting-started 0 events 2026-10-17T12:06:25Z to 2026-10-19T12:06:25Z Hold at 0 Sentry metric docs.page.not_found, project:develop-docs, grouped by requested_path. The 48h 404s were sdk/telemetry 4, sdk/foundations 1, self-hosted/backup 1, and the schema path above.
docs.page.load for /sdk/getting-started/standards/spec-lifecycle/ 2 loads 2026-10-17T12:06:25Z to 2026-10-19T12:06:25Z Hold near 1-3. Escalate if 0 while other standards paths still load Sentry metric docs.page.load, project:develop-docs, path:/sdk/getting-started/standards/spec-lifecycle/. Other 48h standards loads: code-submission 3, repository-docs 1, standards index 1.

If the error rate rises, inspect error logs for Failed to fetch RSC payload on /sdk/getting-started/standards/ URLs.

Not observable

Successful static HTTP 200 bodies for /schemas/spec-compliance.json after the file ships. Vercel may serve that file without a server span. Schema validation of real SDK manifests is not in telemetry. Correctness of the new prose is not in telemetry. A 7d docs.page.load group-by for standards paths timed out, so that slice uses the 48h window only.

Get Slack DMs about this change: cursor.com/automations/rollouts

This branch was successfully deployed

2 active (1 outdated) deployments
Preview – develop-docs — cb322e11 Deployed Oct 19, 2026 by vercel[bot]
Preview – sentry-docs — 718aaf73 Deployed Oct 19, 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.

1 participant