Skip to content
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

ref(remix): Improve Remix SDK docs and wizard #5429

Merged
merged 6 commits into from
Aug 17, 2022
Merged

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Aug 16, 2022

This PR makes a few small improvements to our Remix SDK documentation and the onboarding wizard. While working on #5413 and #5415 I came across some things that IMO could be slightly improved. Furthermore, during the review of the two PRs a few additional things came up that we should also address in the Remix docs.

Specifically, this PR

  • disables the "Installation Methods" section in the left nav menu. (Doesn't make sense for Remix b/c the only installation method is NPM)
  • Fixes a few broken links (which didn't work b/c of some formatting problems)
  • repositions and adjusts a sentence regarding the SDK functionality "verification" (i.e. the section to send your first event)
  • Adds a basic SDK functionality "verification" step to the onboarding wizard (for consistency with our other SDKs).

@vercel
Copy link

vercel bot commented Aug 16, 2022

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

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview Aug 17, 2022 at 9:46AM (UTC)

Copy link
Member

@AbhiPrasad AbhiPrasad left a comment

Choose a reason for hiding this comment

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

Awesome, thank you!

Copy link
Contributor

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

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

Just fixed a typo, but otherwise LGTM! Thanks for doing this!

src/wizard/javascript/remix.md Outdated Show resolved Hide resolved
@Lms24 Lms24 enabled auto-merge (squash) August 17, 2022 09:30
@Lms24 Lms24 merged commit bde333d into master Aug 17, 2022
@Lms24 Lms24 deleted the lms-improve-remix-docs branch August 17, 2022 09:32
@github-actions github-actions bot locked and limited conversation to collaborators Sep 2, 2022
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.

4 participants