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

Rework SDK landing pages #12103

Open
inventarSarah opened this issue Dec 12, 2024 · 0 comments
Open

Rework SDK landing pages #12103

inventarSarah opened this issue Dec 12, 2024 · 0 comments

Comments

@inventarSarah
Copy link
Collaborator

Problem Statement

Currently, the root page for the SDKs is a quick start guide.
For example, the default page for JavaScript is the JavaScript quick start guide https://docs.sentry.io/platforms/javascript/.
(I call this the SDK landing page in this issue)

Depending on how a user navigates to this page, they may have overlooked the framework-specific SDKs.
The blue info box (see screenshot) is a good quick fix that probably already helped many users find the guides they need.
Image

Still, the way the user gets to this section of the Docs could be further improved.
I created this issue to gather ideas for improving the SDK landing pages and providing a more elegant solution.

So please share any of your ideas and current pain points regarding the SDK landing pages

Solution Brainstorm

Here are my thoughts and ideas:

Restructuring the framework tree

Reduce "JavaScript" to a single page that acts as a more general entry point (and not a quick start guide) and move the current "JavaScript" section under this landing page so it is on the same level as other frameworks.
(To not confuse users, we'd need to rename the pages :) )
Image

Repurposing the landing page

On this landing page, we could provide the list of (JS) frameworks (similar to here: https://docs.sentry.io/platforms/).
Additionally, we could offer more information and resources to help users start/continue working with the SDKs.

Some examples:

Considerations

  • React Native and Unity, for example, only have one SDK -> should they stay as they are now, or should we also adapth them to be consistent with the other SDKs
  • if we provide links to other resources (like videos, blog posts, etc) then we need to maintain these and make sure to add/replace content
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Backlog
Development

No branches or pull requests

2 participants