Skip to content

ref(docs): Remove SplitLayout component and its remaining wrappers - #20017

Merged
sfanahata merged 6 commits into
masterfrom
docs/remove-split-layout
Oct 19, 2026
Merged

sfanahata merged 6 commits into
masterfrom
docs/remove-split-layout

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Removes the SplitLayout component everywhere. Pages that used it now render their text and code as regular docs content, with the standard docs spacing.

  • Removes the <SplitLayout>, <SplitSection>, <SplitSectionText>, and <SplitSectionCode> wrapper lines from all 169 MDX files that used them, including the quick start guides. Only the tag lines and the blank lines around them change. Parsing each file before and after shows the same content once the wrappers are ignored.
  • Deletes src/components/splitLayout/ and its registration in src/mdxComponents.ts.
  • Drops the SplitLayout guidance from .claude/skills/technical-docs/SKILL.md.

Step numbering is unaffected. StepConnector finds its h2 headings with a descendant selector, so it doesn't depend on these wrappers.

This replaces #19984, which made SplitLayout render as a single column.

Merge order

Merge this first. After it merges, the quick start template PRs that also edit these files (#19980 Ruby, #19981 Dart and Flutter, #19982 Python, #19983 JavaScript) will need master merged in. Those conflicts are limited to the removed wrapper tags.

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+

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

via shannon.anahata.

--

View Junior Session [Sentry]

@vercel

vercel Bot commented Oct 15, 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 8:12pm UTC
sentry-docs Ready Ready Preview Oct 19, 2026 8:12pm UTC

Request Review

The quick start template PRs (#19980-#19983) still have to remove the
SplitLayout wrappers from 38 files. Until they merge, render those tags
as plain pass-throughs so the build and preview succeed. Remove this
shim once no MDX file uses the wrappers.

Co-Authored-By: Shannon Anahata <[email protected]>
sentry-junior Bot and others added 3 commits October 16, 2026 20:20
Removes the SplitLayout wrapper tags from the 38 files that the quick
start template PRs also touch, and drops the temporary pass-through.
No MDX file uses SplitLayout anymore, so this PR can merge first.

Co-Authored-By: Shannon Anahata <[email protected]>
@cursor

cursor Bot commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Pages that used a two-column split now show text and code as normal stacked docs.
The plan checks those page loads, snippet copies, not-found rate, and new render errors.
An issue escalates when those page loads drop while other pages hold, or when new render errors appear.

Monitoring in production

Services: sentry-docs, develop-docs.

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

Plan

What changed

The two-column split layout is removed from docs pages.
Those pages now render text and code as ordinary stacked content with standard spacing.
The wrapper tags are gone. The inner text and code fences stay.
The merged tree also unwraps the SDK 2.x python streamed-spans page.
Readers who select 2.x see stacked text and code on that page.
sentry-docs must deploy for the page unwraps to go live.
develop-docs must also deploy because it shares the MDX component registry in src.
The catalog and the Vercel production deploy workflow both name those two services.
The MDX unwraps live only under docs, includes, and platform-includes.

Risk

A missed wrapper tag makes the page fail to render for readers.
A bad unwrap can drop code samples from getting-started pages.
The 2.x versioned page can fail while the current python guide still loads.
The shared registry change can affect develop-docs if any page still called those components.
Readers hit a broken platform guide first.
On-call sees client render errors or a rise in not-found events.
Algolia and kapa fetch failures are existing noise and do not count as this change.

Intended effect

The stacked layout itself has no metric.
Confirm the former split pages still load.
Confirm code blocks on those pages still get copied.
Absent: those path loads fall toward zero while product page loads hold.
Absent: snippet copies stay at zero while those path loads hold.

Signal Baseline Window Rule Source
docs.page.load on /platforms/javascript/guides/nextjs/ 1.5-1.6% of platforms docs.page.load (127-143 loads per 24h) 2026-10-14T20:40:00Z to 2026-10-16T20:40:00Z Hold in the band. This is the expected hold, not a rise. Sentry org sentry project docs, environment:production, group by path
docs.page.load on /platforms/python/ 0.99-1.01% of platforms docs.page.load (79-95 loads per 24h) 2026-10-14T20:40:00Z to 2026-10-16T20:40:00Z Hold in the band. Sentry org sentry project docs, environment:production, group by path
docs.snippet_copy with page_path /platforms/javascript 46-101 copies per 24h 2026-10-14T20:40:00Z to 2026-10-16T20:40:00Z Hold in the band. Absent if copies stay at 0 while the nextjs path loads hold. The copy count swings day to day. Sentry org sentry project docs, environment:production, group by page_path

Regression watch

A failed render shows as a new React error or as a 404.
Platform page-load share should hold if only layout changed.
Product page loads are the sibling path on the same site.
The version selector can serve the 2.x python streamed-spans page on its own path.

Signal Baseline Window Rule Source
Production errors whose message matches hydration, MDX, SplitLayout, or Element type is invalid 0 events per 24h 2026-10-15T20:40:00Z to 2026-10-16T20:40:00Z Hold at 0. This class is a fault. Check both docs and develop-docs. Sentry org sentry projects docs and develop-docs, environment:production
docs.page.not_found as a share of docs.page.load 0.31-0.35% (55-61 not-found events per 24h against 15794-19882 page loads) 2026-10-14T20:40:00Z to 2026-10-16T20:40:00Z Hold in the band. A rise with a drop in platforms page loads means a broken path. Sentry org sentry project docs, environment:production
platforms docs.page.load as a share of all docs.page.load 48.7-49.4% (7806-9580 platforms loads per 24h against 15794-19882 total) 2026-10-14T20:40:00Z to 2026-10-16T20:40:00Z Hold in the band. A fall while product page loads hold isolates this change. Sentry org sentry project docs, environment:production, group by page_type
product docs.page.load 19.7-22.3% of all docs.page.load (3114-4443 loads per 24h) 2026-10-14T20:40:00Z to 2026-10-16T20:40:00Z Hold in the band. This is the sibling path. Sentry org sentry project docs, environment:production, page_type:product

If the not-found rate rises, check logs for missing platform getting-started paths.
Also check /platforms/python/tracing/streamed-spans/ and the 2.x versioned path.
If render errors appear, check titles for unknown MDX components or hydration mismatch.

Not observable

The visual switch from two columns to stacked content has no telemetry.
Pageload CLS and LCP queries on traces returned no rows. Traces sample at 30%.
Pageload p95 duration was not confirmed. Transaction name is /:path*? and is not path-sliced.
Python snippet-copy volume is too sparse for a band. Use the python page-load row instead.
Page loads for /platforms/python/tracing/streamed-spans/ and its 2.x path were not measured. The metric query timed out.

Resolve conflict in python/tracing/streamed-spans/index.mdx by taking
master's content (#19831) and removing its SplitLayout wrappers. Also
remove SplitLayout wrappers from the new index__v2.x.mdx page added on
master.

Co-Authored-By: Shannon Anahata <[email protected]>
@sfanahata
sfanahata merged commit 02a3256 into master Oct 19, 2026
28 checks passed
@sfanahata
sfanahata deleted the docs/remove-split-layout branch October 19, 2026 20:17
sentry-junior Bot added a commit that referenced this pull request Oct 19, 2026
Resolve conflicts from #20017 (SplitLayout removal): keep this branch's
content without the removed wrapper tags, and keep master's other
changes to the same files.

Co-Authored-By: Shannon Anahata <[email protected]>
sentry-junior Bot added a commit that referenced this pull request Oct 19, 2026
Resolve conflicts from #20017 (SplitLayout removal): keep this branch's
content without the removed wrapper tags, and keep master's other
changes to the same files.

Co-Authored-By: Shannon Anahata <[email protected]>
sentry-junior Bot added a commit that referenced this pull request Oct 19, 2026
Resolve conflicts from #20017 (SplitLayout removal): keep this branch's
content without the removed wrapper tags, and keep master's other
changes to the same files.

Co-Authored-By: Shannon Anahata <[email protected]>
sentry-junior Bot added a commit that referenced this pull request Oct 19, 2026
Resolve conflicts from #20017 (SplitLayout removal): keep this branch's
content without the removed wrapper tags, and keep master's other
changes to the same files.

Co-Authored-By: Shannon Anahata <[email protected]>
@cursor

cursor Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Verified in production

  • Developer docs pages still load after the layout registry change, and render errors did not rise.
  • The former split pages still load.

This branch was successfully deployed

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

2 participants