docs(js): Update quick start guide splitlayout for Solid, SolidStart, Svelte#17451
Open
inventarSarah wants to merge 1 commit intomasterfrom
Open
docs(js): Update quick start guide splitlayout for Solid, SolidStart, Svelte#17451inventarSarah wants to merge 1 commit intomasterfrom
inventarSarah wants to merge 1 commit intomasterfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Comment on lines
331
to
+334
|
|
||
| </OnboardingOption> | ||
|
|
||
| </OnboardingSteps> | ||
| </StepConnector> |
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
This branch updates the following quick start guides to use the new split layout:
Closes: #17449
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
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