Platform / Guide Inheritance

[stephanie-anderson]

Problem Statement

Right now, we have a lot of different platforms (often, but not always the platform relates directly to languages):

docs/platforms
├── android
├── apple
├── dart
├── dotnet
├── elixir
├── flutter
├── go
├── java
├── javascript
├── kotlin
├── kotlin-multiplatform
├── native
├── node
├── php
├── python
├── react-native
├── ruby
├── rust
├── unity
└── unreal

Some of those platforms have dedicated guides. We created those for frameworks (and sometimes other libraries):

docs/platforms/java/guides
├── jul
├── log4j2
├── logback
├── servlet
├── spring
└── spring-boot

With JavaScript we keep running into difficulties. For JS, two different platforms have been created:

• Browser JavaScript
• Node.js

docs/platforms/javascript/guides
├── angular
├── astro
├── bun
├── capacitor
├── cordova
├── deno
├── electron
├── ember
├── gatsby
├── nextjs
├── react
├── remix
├── solid
├── svelte
├── sveltekit
├── vue
└── wasm

docs/platforms/node/guides
├── aws-lambda
├── azure-functions
├── connect
├── express
├── gcp-functions
└── koa

This wasn't a problem for a long time, because frameworks (and therefore guides) did only inherit from either the Browser JS documentation OR the Node.js documentation. (e.g. vue would inherit from javascript - express would inherit from node).

But with all the meta/fullstack frameworks being created, we need a better solution. Frameworks like nextjs should be able to inherit hand-picked parts from javascript, and parts from node. And maybe other runtimes in the future as well?

Solution Brainstorm

The sky is the limit. Maybe we need to combine node and browser javascript and take it from there? We definitely need some brainstorming on this.

(Whatever we do, we definitely need to make sure that pages do not 404 afterwards, but are properly redirected.)

[stephanie-anderson]

Hey @a-hariti ! Maybe this is something where you wanna add some ideas?

[stephanie-anderson]

Related issue for React Native: https://github.com/getsentry/sentry-docs/issues/4461