Skip to content

docs(js): Update quick start guide splitlayout for Solid, SolidStart, Svelte#17451

Open
inventarSarah wants to merge 1 commit intomasterfrom
smi/quick-start/splitlayout-solid-svelte
Open

docs(js): Update quick start guide splitlayout for Solid, SolidStart, Svelte#17451
inventarSarah wants to merge 1 commit intomasterfrom
smi/quick-start/splitlayout-solid-svelte

Conversation

@inventarSarah
Copy link
Copy Markdown
Collaborator

DESCRIBE YOUR PR

This branch updates the following quick start guides to use the new split layout:

  • Solid
  • SolidStart
  • Svelte

Closes: #17449

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

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.

EXTRA RESOURCES

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 23, 2026

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Apr 23, 2026 9:05am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Apr 23, 2026 9:05am

Request Review

Comment on lines 331 to +334

</OnboardingOption>

</OnboardingSteps>
</StepConnector>
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Bug: The ## Next Steps heading in the Svelte guide is unintentionally auto-numbered by the StepConnector component, disrupting the document's flow.
Severity: LOW

Suggested Fix

To prevent numbering, add the data-no-number attribute to the h2 element for "Next Steps". Alternatively, restructure the document to move the heading outside the StepConnector's scope, for example by using an <Expandable title="Next Steps"> component without a preceding h2.

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: docs/platforms/javascript/guides/svelte/index.mdx#L331-L334

Potential issue: In the Svelte guide, the `StepConnector` component automatically
numbers all `h2` headings within its scope. The `## Next Steps` heading is an `h2`
element placed inside the `StepConnector`, which will cause it to be unintentionally
numbered as part of the setup guide. This disrupts the visual flow of the documentation
and misrepresents the "Next Steps" section as a required step, which is inconsistent
with other guides updated in this pull request.

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

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.

Solid, SolidStart, Svelte quick start guide split format

1 participant