Repository navigation
feat(docs): Render SplitLayout as a single column - #19984
sentry-junior[bot] wants to merge 2 commits into
Conversation
Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Pages that pair text with a code sample now stack in one column at every width. The plan checks snippet copies, layout shift, largest paint, and client errors. An issue escalates when layout shift or errors rise, or when snippet copies collapse while page loads hold. Services: Mention PlanWhat changedPages that use SplitLayout now show each section's text first, then its code sample, at every viewport width. The two-column grid and the sticky code panel are gone. sentry-docs must deploy before this layout is live. develop-docs also builds this shared component from the same source. No develop-docs page renders SplitLayout. Deploy config maps the Vercel projects sentry-docs and develop-docs to those catalog ids. RiskA bad stylesheet can hide code samples or make them overflow. Desktop pages get longer, so layout shift and largest paint can worsen. The client layout wrapper can throw during hydrate. Code tabs and copy buttons on these pages can become hard to use. Intended effectThe stacked layout itself has no metric. Treat snippet copies on platform SDK paths as the proxy that code samples stay visible and usable. Absent looks like this: page loads on the SplitLayout routes hold, and
Regression watchThis stylesheet change can shift the page, delay first paint, or throw on hydrate. Pageload transactions use
Not observableThe stacked single-column layout itself has no queryable signal. CLS cannot be split by SplitLayout route because pageload transactions are |
Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
…20017) ## 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 - [x] 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](https://github.com/orgs/getsentry/teams/docs) <!-- junior-request-attribution:start --> via **shannon.anahata**. <!-- junior-request-attribution:end --> <!-- junior-session-footer:start --> <!-- junior-conversation-id:slack%3AD0BB8KQT6MU%3A1792013336.218129 --> -- [View Junior Session](https://junior-prod.sentry.dev/conversations/slack%3AD0BB8KQT6MU%3A1792013336.218129) [[Sentry]](https://sentry.sentry.io/explore/conversations/slack%3AD0BB8KQT6MU%3A1792013336.218129/?project=4510944073809921) <!-- junior-session-footer:end --> --------- Co-authored-by: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com> Co-authored-by: Shannon Anahata <shannon.anahata@sentry.io>
DESCRIBE YOUR PR
Switches every page that uses
SplitLayoutto a single column. The SDK quick starts, OTLP pipeline guides, feature pages, and other pages that use it now show each section's text first, followed by its code sample, at every viewport width.This changes only the component. The styles drop the two-column grid and the sticky code panel, which leaves the layout pages already used below 1024px. No MDX content changes, so this doesn't conflict with the open quick start template PRs (#19980, #19981, #19982, #19983). The
<SplitLayout>wrappers in MDX keep working and can be removed in a later cleanup if we want.The component README and doc comment are updated to describe the single-column behavior.
IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST
via shannon.anahata.
--
View Junior Session [Sentry]