Documentation Map
MediaSFU has a few public guide surfaces because different visitors need different levels of detail. Use this map when you are choosing where to start or when an older link brought you here.
Choose by audience
| Need | Best place | Why |
|---|---|---|
| Configure the dashboard without writing code | User Guides Hub | Non-technical walkthroughs for rooms, recordings, billing, Lite Dashboard, widgets, telephony, and day-to-day account usage. |
| Follow the full dashboard walkthrough | Dashboard User Guide | The visual guide that used to own the public /docs experience, kept for no-code and operations readers. |
| Work with rooms, domains, recordings, sub-users, AI credentials, SIP, widgets, translation, or disposable keys | Developer Console Guide | Interactive developer-facing reference for MediaSFU dashboard and REST-style platform features. |
| Build with an SDK | SDK Guides | Framework setup for ReactJS, Angular, React Native, Expo, Vue, Flutter, Kotlin, and shared-core integrations. |
| Find signatures and generated class/function docs | API Reference or Generated API Docs | The overview explains the packages; the generated API root opens the staged TypeDoc, Dartdoc, and Dokka/KDoc references. |
| Compare starter product screens | Starter Screens | Visual targets for WhatsApp-style calls, Twitch-style host dashboards, TikTok Live guest queues, and support consoles. |
| Inspect React UI surfaces visually | Storybook Visual Preview or Storybook App | Storybook is the React visual companion; this portal remains the implementation guide. |
Compatibility routes
Older public links continue to point somewhere useful:
| Older route | Current destination |
|---|---|
/docs/ | This docs portal for SDKs, usage paths, API overview, and public implementation guidance. |
/documentation | Developer Console Guide for dashboard/API feature configuration. |
/docs-new | This documentation map. |
/quick-usage and /cheat-code | Quick Usage Guide for SDK selection, secure room setup, UI ownership, and generated API links. |
/components | Storybook visual preview guidance. |
/docs/api/ | Generated API docs landing page. |
Where Each Guide Fits
Use each route for the audience it serves best:
- Keep SDK setup, usage paths, generated API links, and starter implementation recipes in this docs portal.
- Keep dashboard walkthroughs and low-code/no-code operational guides in the main MediaSFU user guide surfaces.
- Keep developer console feature guides that depend on the live dashboard UI in
/documentation. - Keep fast cross-surface orientation in
/quick-usage, then link readers into the canonical SDK, API, and dashboard guides. - Keep React component exploration in Storybook and link back to this portal for production integration details.