Change all occurrences of previous sandbox/prod distinction to reflect our new model#251
Open
Change all occurrences of previous sandbox/prod distinction to reflect our new model#251
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates documentation to reflect the Sandbox rework by introducing the Sandbox API URL as an explicit input to useSandbox(...) across React/React Native and sandbox-related guides.
Changes:
- Update quick starts and tutorials to instruct users to copy both Fishjam ID and Sandbox API URL, and to pass
sandboxApiUrlintouseSandbox(...). - Refresh sandbox API testing docs and examples to align with the new room-manager URL model.
- Add/expand conceptual documentation explaining the relationship between Sandbox API URL (room manager) and Fishjam ID (media server environment).
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tutorials/react-quick-start.mdx | Updates onboarding + examples to use useSandbox({ sandboxApiUrl }) and document where to find the URL. |
| docs/tutorials/react-native-quick-start.mdx | Same as web quick start for React Native. |
| docs/tutorials/livestreaming.mdx | Updates sandbox livestreaming examples to pass sandboxApiUrl into useSandbox(...). |
| docs/how-to/client/picture-in-picture.mdx | Updates viewer-token examples to pass sandboxApiUrl into useSandbox(...). |
| docs/how-to/client/migration-guide.mdx | Updates migration snippet to include sandboxApiUrl usage. |
| docs/how-to/client/connecting.mdx | Updates sandbox token retrieval and join-room examples to pass sandboxApiUrl and fixes hook dependency list. |
| docs/how-to/backend/sandbox-api-testing.mdx | Reworks the sandbox testing guide to require Sandbox API URL and updates examples/troubleshooting/security notes. |
| docs/how-to/backend/production-deployment.mdx | Updates “remove sandbox usage” example to include sandboxApiUrl (but currently mixes frontend hook usage with Express context). |
| docs/explanation/sandbox-api-concept.mdx | Adds explanation section describing Sandbox API URL vs Fishjam ID roles. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Magmusacy
changed the title
czerwiukk
reviewed
May 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documentation should now be up to date with our new changes made to room manager as well as web-client-sdk