-
Notifications
You must be signed in to change notification settings - Fork 1
Update documentation adding the new mobile sdk #217
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the documentation to integrate the new mobile SDK (@fishjam-cloud/mobile-client) which is now based on the web SDK. The documentation for web (React) and mobile (React Native) platforms has been consolidated into unified how-to guides under a new client/ directory.
Changes:
- Migrated from
@fishjam-cloud/react-native-clientto@fishjam-cloud/mobile-client - Consolidated web and mobile documentation into unified guides with platform-specific sections
- Added CSS badge styles to distinguish between web-only and mobile-only features
- Updated all code examples and API references to use the new SDK
Reviewed changes
Copilot reviewed 52 out of 53 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Updated dependency from react-native-client to mobile-client |
| yarn.lock | Added mobile-client package link |
| docusaurus.config.ts | Updated TypeDoc entry points for mobile API |
| scripts/prepare.sh | Changed build path for mobile client |
| .gitmodules | Updated web-client-sdk branch reference |
| src/css/custom.css | Added platform badge styles for documentation |
| docs/tutorials/*.mdx | Updated quick-start guides with new SDK examples |
| docs/how-to/client/*.mdx | New unified guides with platform tabs |
| docs/how-to/react/*.mdx | Removed (consolidated into client/) |
| docs/how-to/react-native/*.mdx | Removed (consolidated into client/) |
| docs/index.mdx | Updated links to new unified documentation |
| docs/how-to/features/*.mdx | Updated SDK import references |
| docs/how-to/backend/server-setup.mdx | Updated metadata documentation link |
| docs/explanation/public-livestreams.mdx | Updated code examples for new SDK |
Comments suppressed due to low confidence (1)
docs/how-to/client/picture-in-picture.mdx:184
- The code uses type assertions with
as anywhich bypasses TypeScript's type checking. This pattern is repeated multiple times (lines 183, 184, 328, 329). Consider defining proper types for the ref or providing a more type-safe solution in the documentation examples.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
08ef0c6 to
787c70a
Compare
fb23a18 to
bd0f47d
Compare
bd0f47d to
380c9c7
Compare
7118930 to
55b3e17
Compare
4fd40f2 to
dbf8f11
Compare
Description
Update documentation adding the new mobile sdk. Since the new mobile sdk is based on the web sdk, How-to-guides for mobile and web were joined together.