Improve JS SDK Getting Started pages
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
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.
@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).
Let's leave the linked doc out for now, this needs more discussion :)
Progress
- [x] Browser Javascript
- [x] Angular Wizard
- [x] Angular Manual
- [ ] Astro
- [x] Azure Functions
- [x] Bun
- [x] Cloudflare
- [ ] Cloudflare Astro
- [x] Cloudflare Hono
- [x] Cloudflare Nuxt
- [x] Cloudflare Remix
- [x] Cloudflare SvelteKit
- [x] Connect (Review)
- [x] Deno
- [x] Electron
- [x] Ember
- [x] Express
- [x] Fastify (Review)
- [x] Google Cloud Functions
- [x] Hapi (Review)
- [x] Hono
- [x] Koa (Review)
- [x] Nest.js
- [x] Next.js Wizard
- [x] Next.js Manual
- [x] Node.js
- [x] Nuxt Wizard
- [x] Nuxt Manual
- [x] React
- [x] React Router Framework
- [x] Remix Wizard
- [x] Remix Manual
- [x] Solid
- [x] SolidStart
- [x] Svelte
- [x] SvelteKit Wizard
- [x] SvelteKit Manual
- [x] TanStack Start React (Review)
- [x] Vue
- [x] Wasm