Skip to content

ref(sveltekit): Improve manual setup code snippets and structure #11038

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 9, 2024

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Aug 9, 2024

builds on top of #10990

DESCRIBE YOUR PR

This PR adds a couple of improvements to the manual setup page of our SvelteKit guide:

  • streamlined code snippets so that there's only one snippet per file users need to change. Since we can now highlight parts in snippets, I think it's easier for users to identify what they need to change in a file on one glance instead of piecing together two or three snippets.
  • Removed TS and JS tabs in the snippets because there's no TS-specific syntax in them.
  • Restructured H2 document structure so that not all optional configuration sections are part of "Configuration". This should help users identify what they have to do vs. what's optional and probably not necessary to read.

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+

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

Copy link

vercel bot commented Aug 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 9, 2024 11:39am
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 9, 2024 11:39am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Aug 9, 2024 11:39am

@Lms24 Lms24 changed the base branch from master to lms/feat-sveltekit-wrapServerRouteWithSentry-docs August 9, 2024 09:12
@Lms24 Lms24 requested a review from nicohrubec August 9, 2024 09:17
@Lms24 Lms24 self-assigned this Aug 9, 2024
Copy link

codecov bot commented Aug 9, 2024

Bundle Report

Changes will decrease total bundle size by 15 bytes ⬇️

Bundle name Size Change
sentry-docs-server 8.26MB 6 bytes ⬇️
sentry-docs-edge-server 254.16kB 3 bytes ⬇️
sentry-docs-client 6.25MB 6 bytes ⬇️

Copy link
Contributor

@nicohrubec nicohrubec left a comment

Choose a reason for hiding this comment

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

nice!

Base automatically changed from lms/feat-sveltekit-wrapServerRouteWithSentry-docs to master August 9, 2024 11:21
@Lms24 Lms24 force-pushed the lms/ref-sveltekit-manual-setup branch from ab0043c to 08af5b7 Compare August 9, 2024 11:22
@Lms24 Lms24 enabled auto-merge (squash) August 9, 2024 11:22
@Lms24 Lms24 merged commit b3a09d1 into master Aug 9, 2024
9 checks passed
@Lms24 Lms24 deleted the lms/ref-sveltekit-manual-setup branch August 9, 2024 11:39
@github-actions github-actions bot locked and limited conversation to collaborators Aug 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants