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

Small tweaks to intro navigation for a more intuitive flow #11784

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

coolguyzone
Copy link
Collaborator

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.

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

Copy link

vercel bot commented Nov 12, 2024

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

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 12, 2024 9:53pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Nov 12, 2024 9:53pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Nov 12, 2024 9:53pm

Copy link

codecov bot commented Nov 12, 2024

Bundle Report

Changes will decrease total bundle size by 29 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 8.59MB 23 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 8.94MB 6 bytes (-0.0%) ⬇️

@coolguyzone
Copy link
Collaborator Author

Hi @lizokm , after a lot of back and forth I settled on some pretty minimal tweaks. Go to https://sentry-docs-git-nav-tweak.sentry.dev/ and click on 'What Is Sentry' to check out. Essentially I have that link go straight to the '/product/' page which I think does a better job of answering the question. I also renamed 'Intro to Sentry' to 'Getting Started With Sentry', which I think feels more like a place where you learn how to get the most out of sentry and learn about tutorials.

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

I think this is a good solution! The only other thing I'd tweak slightly is the description copy in "Product Walkthroughs". I'd just make it answer the question "What is Sentry". Maybe something like: "Sentry can be used to not just observe, but debug errors...". and then finish with something along the lines of learning about the uses with the product walkthroughs.

docs/product/sentry-basics/index.mdx Show resolved Hide resolved
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.

2 participants