Skip to content

docs(integrations): Consolidate code mappings onto one page - #20037

Merged
Abdkhan14 merged 3 commits into
masterfrom
coolguyzone/docs/code-mappings-refactor
Oct 21, 2026
Merged

Abdkhan14 merged 3 commits into
masterfrom
coolguyzone/docs/code-mappings-refactor

Conversation

@coolguyzone

@coolguyzone coolguyzone commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Code mapping setup is moving out of the integration configuration tab and into project and repository settings. This PR consolidates the docs to match.

Today the setup walkthrough is copied under every SCM integration and again under Suspect Commits. Every copy describes the old Settings > Integrations > Configure > Code Mappings tab and the old Stack Trace Root / Source Code Root field names. This replaces those copies with one canonical page and short provider-specific links.

  • Add /integrations/source-code-mgmt/code-mappings/ covering what code mappings do, both new entry points, the path fields, how to pick prefixes, editing, automatic mappings, bulk upload, and platform exceptions
  • Replace the duplicated setup on the GitHub, GitLab, Bitbucket, Azure DevOps, Perforce, and Cursor Origin pages, keeping each provider's #stack-trace-linking anchor and provider-specific behavior
  • Trim Suspect Commits to suspect-commit behavior and drop the stale Arcade demo
  • Rename Stack Trace Root to Stack trace prefix and Source Code Root to Repository prefix on the Java, Godot, and Cursor Origin pages (the CLI JSON keys stackRoot and sourceRoot are unchanged)
  • Repoint code mapping links on SCM Source Context, Ownership Rules, Web Vitals, Go source context and troubleshooting, and the CLI page
  • List the new page under Features on the Source Code Management index
  • Add three screenshots of the new UI: the Connected Repositories panel, the organization Repositories page, and the connect modal
  • Delete the stale configure-modal include and five duplicated copies of the native stack trace screenshot

No redirects are needed: the old content lived at anchors on pages that still exist, and every one of those anchors is preserved.

Note for reviewers

Per the spec, this is written as though organizations:code-mappings-refactor is fully rolled out and the integration Code Mappings tab is gone. The Vercel preview will describe UI that may not match production yet.

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

@vercel

vercel Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Oct 19, 2026 11:52pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 19, 2026 11:52pm UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 16, 2026
@codeowner-assignment
codeowner-assignment Bot requested review from a team October 16, 2026 19:00
@coolguyzone
coolguyzone requested review from Abdkhan14 and a balanced review from Copilot and removed request for a team October 16, 2026 19:07

Copilot AI 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.

🔵 Needs a closer look

The rollout-dependent workflow needs human validation, and three planned UI screenshots remain outstanding.

0 open findings

What changed in this PR

Consolidates code mapping documentation around the new project and repository settings workflow.

Changes:

  • Adds a canonical setup guide covering prefixes, editing, automatic mappings, and bulk uploads.
  • Replaces duplicated provider walkthroughs with links and updates field names and cross-references.
  • Removes obsolete setup content and reuses a central native stack trace screenshot.
File Description
includes/​common-imgs/​code-mappings-configure-modal.md Removes obsolete modal include.
docs/​product/​issues/​suspect-commits/​index.mdx Links canonical setup; removes stale demo.
docs/​product/​issues/​ownership-rules/​index.mdx Updates code mapping links.
docs/​product/​issues/​issue-details/​performance-issues/​web-vitals/​index.mdx Updates prerequisite link.
docs/​platforms/​java/​common/​source-context/​index.mdx Updates field names and setup link.
docs/​platforms/​godot/​configuration/​source-context.mdx Updates prefix terminology and setup link.
docs/​platforms/​go/​common/​troubleshooting.mdx Links canonical mapping guidance.
docs/​platforms/​go/​common/​source-context/​index.mdx Links canonical setup.
docs/​integrations/​source-code-mgmt/​source-context/​index.mdx Updates setup reference.
docs/​integrations/​source-code-mgmt/​perforce/​index.mdx Consolidates setup; preserves depot-specific guidance.
docs/​integrations/​source-code-mgmt/​index.mdx Lists Code Mappings under Features.
docs/​integrations/​source-code-mgmt/​gitlab/​index.mdx Replaces duplicated setup with canonical link.
docs/​integrations/​source-code-mgmt/​github/​index.mdx Consolidates setup and updates prerequisite link.
docs/​integrations/​source-code-mgmt/​cursor-origin/​index.mdx Consolidates setup and updates field names.
docs/​integrations/​source-code-mgmt/​code-mappings/​index.mdx Adds canonical configuration guide.
docs/​integrations/​source-code-mgmt/​code-mappings/​img/​code-mappings-stacktrace-native.png Provides shared native stack trace example.
docs/​integrations/​source-code-mgmt/​bitbucket/​index.mdx Replaces duplicated setup with canonical link.
docs/​integrations/​source-code-mgmt/​azure-devops/​index.mdx Replaces duplicated setup with canonical link.
docs/​cli/​code-mappings.mdx Updates web UI setup link.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

coolguyzone and others added 3 commits October 19, 2026 16:45
Code mapping setup is moving out of the integration configuration tab
and into project and repository settings. The setup walkthrough was
copied under every SCM integration and under Suspect Commits, each copy
describing the old Settings > Integrations > Configure > Code Mappings
tab and the old Stack Trace Root / Source Code Root field names.

Add a canonical page at /integrations/source-code-mgmt/code-mappings/
covering path configuration only, and reduce the duplicated sections to
a short description plus a link. Provider install, commit tracking, and
resolve-via-commit stay on the integration pages.

- Add the canonical page: what code mappings do, both new entry points,
  path fields, how to pick prefixes, editing, automatic mappings, bulk
  upload, and platform exceptions
- Replace the duplicated setup on the GitHub, GitLab, Bitbucket, Azure
  DevOps, Perforce, and Cursor Origin pages, keeping each provider's
  Stack Trace Linking anchor and provider-specific behavior
- Trim Suspect Commits to suspect-commit behavior and drop the stale
  Arcade demo
- Rename Stack Trace Root to Stack trace prefix and Source Code Root to
  Repository prefix across the Java, Godot, and Cursor Origin pages
  (the CLI JSON keys stackRoot and sourceRoot are unchanged)
- Repoint code mapping links on SCM Source Context, Ownership Rules,
  Web Vitals, Go source context and troubleshooting, and CLI
- List the new page under Features on the Source Code Management index
- Delete the stale configure-modal include and the five duplicated
  copies of the native stack trace screenshot

Screenshots of the new UI are still to come; three placeholders are
marked in the canonical page.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Tighten the voice on the canonical page: use "repo" over "repository"
in prose, lead the feature list with what each feature does, and even
out the phrasing in the setup and edit sections.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Replace the three screenshot placeholders on the canonical page with
captures of the new UI: the Connected Repositories panel in project
settings, the organization Repositories page, and the connect modal.

Also describe the modal's Example preview, which the connect modal
screenshot shows but the page didn't explain.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@coolguyzone
coolguyzone force-pushed the coolguyzone/docs/code-mappings-refactor branch from 8d05b0d to 26a758a Compare October 19, 2026 23:45
@codeowner-assignment
codeowner-assignment Bot requested review from a team October 19, 2026 23:45
@coolguyzone
coolguyzone marked this pull request as ready for review October 20, 2026 00:07
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 20, 2026 00:07
@cursor

cursor Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks page loads on the new setup page. It also checks GitHub and GitLab page loads, 404s, and error events. An issue escalates when the new page stays unused or those 404s rise.

Monitoring in production

Services: sentry-docs.

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

Plan

What changed

Requests to /integrations/source-code-mgmt/code-mappings/ now serve the full setup page. Provider pages keep their URLs and send readers to that page.

sentry-docs must deploy before this is live. Vercel production for sentry-docs ships docs/ MDX. This change does not edit app/ or src/, so develop-docs does not ship it.

Risk

A missing new page returns a 404 and blocks setup. A broken GitHub or GitLab page drops those page loads and raises 404s. A broken suspect commits page hides the remaining guidance. New screenshots can fail to render on the setup page.

Intended effect

The new setup page must gain page loads after deploy. GitHub and GitLab pages still loading while this counter stays at the pre-deploy noise means absent.

The last 24h already shows 4 page loads. The last 7d shows 8. That traffic may be preview noise. Confirmed means a rise above that noise as provider pages link here.

Signal Baseline Rule Source
docs.page.load for path:"/integrations/source-code-mgmt/code-mappings/" 4 page loads in 2026-10-19T00:08:08Z to 2026-10-20T00:08:08Z. 8 page loads in 2026-10-13T00:08:08Z to 2026-10-20T00:08:08Z Rise above 4 page loads per 24h Sentry org sentry project docs

Regression watch

Broken MDX on this path 404s under integrations/source-code-mgmt. GitHub and GitLab pages must keep serving. Suspect commits must keep serving after the trim.

Sunday 24h page loads were lower than Monday. Stay inside the measured 24h band. A drop to zero on GitHub or GitLab is a regression even inside a quiet window.

Signal Baseline Rule Source
docs.page.not_found for requested_path:"integrations/source-code-mgmt" 0 events in 2026-10-19T00:08:08Z to 2026-10-20T00:08:08Z. 0 events in 2026-10-18T00:08:08Z to 2026-10-20T00:08:08Z. GitHub plus GitLab page loads were 92 in that same 24h Hold at 0 Sentry org sentry project docs
docs.page.load for GitHub plus GitLab paths GitHub 56 and GitLab 36 in 2026-10-19T00:08:08Z to 2026-10-20T00:08:08Z. GitHub 19 and GitLab 8 in 2026-10-18T00:08:08Z to 2026-10-19T00:08:08Z. GitHub 346 and GitLab 161 in 2026-10-13T00:08:08Z to 2026-10-20T00:08:08Z Hold in 27-92 combined page loads per 24h Sentry org sentry project docs, path:"/integrations/source-code-mgmt/github/" and path:"/integrations/source-code-mgmt/gitlab/"
docs.page.load for path:"/product/issues/suspect-commits/" 7 page loads in 2026-10-19T00:08:08Z to 2026-10-20T00:08:08Z. 15 page loads in 2026-10-18T00:08:08Z to 2026-10-20T00:08:08Z Hold in 7-15 page loads per 24h. Treat 0 as a regression Sentry org sentry project docs
Error events with source-code-mgmt in the URL 0 events in 2026-10-19T00:08:08Z to 2026-10-20T00:08:08Z for environment:production source-code-mgmt Hold at 0 Sentry org sentry project docs

Not observable

Pageload latency and HTTP 5xx traces timed out. Image file 404s do not increment docs.page.not_found. The docs describe UI that may not match production until the product change is on. That mismatch is not visible in docs telemetry.

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

@Abdkhan14
Abdkhan14 merged commit 14991c7 into master Oct 21, 2026
29 checks passed
@Abdkhan14
Abdkhan14 deleted the coolguyzone/docs/code-mappings-refactor branch October 21, 2026 18:26
@cursor

cursor Bot commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • The new setup page gained page loads after the ship.

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 26a758a2 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants