Skip to content

docs(js): Use split layout in browser JS quick start guide#17101

Open
inventarSarah wants to merge 1 commit intomasterfrom
smi/quick-start/split-layout-js
Open

docs(js): Use split layout in browser JS quick start guide#17101
inventarSarah wants to merge 1 commit intomasterfrom
smi/quick-start/split-layout-js

Conversation

@inventarSarah
Copy link
Collaborator

DESCRIBE YOUR PR

This is the first in a series of PRs to update all JS quick start guides to the new split layout.

I'm starting with a single guide to validate the approach with @sergical before proceeding.

Note:
I had to inline some includes temporarily since the include files are shared across multiple guides. I will update and use them again once all guides are updated.

Closes: #16903

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: 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 added an urgent due date to it.
    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

EXTRA RESOURCES

@vercel
Copy link

vercel bot commented Mar 24, 2026

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Mar 24, 2026 9:53am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Mar 24, 2026 9:53am

Request Review


</SplitLayout>

#### Option 2: Loader Script
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we move the other 2 options into the split layout?

It looks better to me this way

Comment on lines +1 to +4
<SplitLayout>

<SplitSection>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: A shared include file, getting-started-config/javascript.mdx, was wrapped in a <SplitLayout>, which will break the layout for non-browser guides like Node.js that use it.
Severity: MEDIUM

Suggested Fix

Instead of modifying the shared include file directly, wrap the <SplitLayout> component within the file with a <PlatformSection platform="javascript.browser">. This will ensure the split layout only renders for browser-based guides and does not affect Node.js or other server-side framework documentation.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: platform-includes/getting-started-config/javascript.mdx#L1-L4

Potential issue: The shared include file
`platform-includes/getting-started-config/javascript.mdx` has been entirely wrapped in a
`<SplitLayout>` component. This file is used by various JavaScript guides, including
those for Node.js and other server-side frameworks. These non-browser guides do not use
the necessary parent layout components that `<SplitLayout>` requires. As a result, when
these guides include the modified file, the layout will render incorrectly, leading to a
broken visual presentation for users viewing the Node.js or server-side framework quick
start documentation.

Did we get this right? 👍 / 👎 to inform future reviews.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't find any other guide that uses this file so it should be fine.

We could inline the content just to be safe

Copy link
Member

@sergical sergical left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i dig it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

JavaScript SDK quick start guide split layout

2 participants