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

Improve JS SDK Getting Started pages #11859

Open
mydea opened this issue Nov 18, 2024 · 3 comments
Open

Improve JS SDK Getting Started pages #11859

mydea opened this issue Nov 18, 2024 · 3 comments

Comments

@mydea
Copy link
Member

mydea commented Nov 18, 2024

SDK

JavaScript SDK

Description

Our "Getting Started" (landing) pages for the JavaScript SDK docs have grown over time. They are not fully consistent and we want to spend some time to improve them.

This task is somewhat broad, and may consist of various improvements. Part of the issue is to investigate the getting started pages and see what we can do better.

Potential things to do

  • General structure of what should be on the Getting Started page (template)
  • How can we explain concepts of things that are covered? E.g. "what is tracing/profiling" and similar questions.
  • How can we provide good, explorable next steps (e.g. setting up tunneling, ...)

Priority of SDKs

While we eventually want to work on all getting started pages, we want to start with JavaScript, then extend to other platforms later. Inside of JS, we may start with React, Browser (Default, "JavaScript"), Next.js and Express, which cover a good amount of our most important JS platforms.

Suggested Solution

No response

@lizokm
Copy link
Contributor

lizokm commented Dec 5, 2024

Here's a draft that Burak has been working on for Node.js. One idea that we have is to bring "set up tracing" (and other features that are available for that SDK) to the main "set up" page. So users know right away about all the options they have.

@s1gr1d
Copy link
Member

s1gr1d commented Dec 10, 2024

@BYK In the linked doc I saw that "Installation Methods" should be removed. However, we need some additional explanation for ESM-based server-side projects. If it's not in Installation Methods, there should be an alternative for adding this content.

Setup for ESM is not that trivial and for people with an ESM project who are not able to add node CLI flags, we have to document other options for setting up their project.

We not only do this in Node, we also do this in Nuxt and have to add this to other Meta-Frameworks as well (as some of them are using ESM on the server-side).

@mydea
Copy link
Member Author

mydea commented Dec 11, 2024

Let's leave the linked doc out for now, this needs more discussion :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

7 participants