Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new Examples section to the Fishjam documentation, with dedicated pages for web/mobile/backend runnable example apps and updated navigation to make them discoverable.
Changes:
- Added an Examples entry to the home quick navigation and adjusted the card layout to support 3 columns.
- Introduced new docs pages for Web, Mobile, and Backend examples, and linked to them from quick start tutorials and the docs homepage.
- Added a new
docs/examplessidebar category and adjusted sidebar ordering so API shifts down.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/content/cardItems.ts | Adds an “Examples” card to the homepage quick navigation items. |
| src/components/QuickNavigation/index.tsx | Updates card grid sizing/styling hooks to show 3 cards per row. |
| src/components/QuickNavigation/index.module.css | Adjusts card container/column styling to better align/size cards. |
| docs/tutorials/react-quick-start.mdx | Adds a “Explore web examples” link in the next-steps list. |
| docs/tutorials/react-native-quick-start.mdx | Adds a “Explore mobile examples” link in the next-steps list. |
| docs/tutorials/backend-quick-start.mdx | Adds a “Explore backend examples” link in the next-steps list. |
| docs/index.mdx | Adds an “Examples” section to the docs homepage content. |
| docs/examples/web.mdx | New page documenting runnable web example apps and what they demonstrate. |
| docs/examples/mobile.mdx | New page documenting runnable mobile example apps and what they demonstrate. |
| docs/examples/backend.mdx | New page documenting runnable backend/headless example apps and what they demonstrate. |
| docs/examples/category.json | Creates the Examples sidebar category and generated index at /examples. |
| docs/api/category.json | Moves API category position down to accommodate Examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
docs/examples/backend.mdx
Outdated
| sidebar_position: 2 | ||
| --- | ||
|
|
||
| # Backend Examples |
There was a problem hiding this comment.
issue: the same applies here - ts-client lib is not backend code. all the backend related repos are "python-server-sdk" and "js-server-sdk"
|
|
||
| ## Minimal React | ||
|
|
||
| The simplest way to get a video call working in the browser — joining a room, displaying your own camera feed, and showing remote participants. Start here if you're new to Fishjam on the web. |
There was a problem hiding this comment.
note: it's worth mentioning that minimal react requires a peerToken to join the room. it can be generated either by calling room manager api or using server sdks.
docs/examples/backend.mdx
Outdated
| sidebar_position: 2 | ||
| --- | ||
|
|
||
| # Backend Examples |
There was a problem hiding this comment.
issue: typescript client is also client code, we can talk today about how are our sdks structured. only backend sdks are python-server-sdk and js-server-sdk
There was a problem hiding this comment.
Pull request overview
Adds an “Examples” area to the Fishjam documentation so readers can quickly find runnable reference apps for React (web) and React Native (mobile).
Changes:
- Add a new
docs/examplessection (category + React/React Native example pages). - Update the docs homepage navigation (new “Examples” card + 3-column layout) and add an “Examples” section to the landing page.
- Link to the new examples pages from the React and React Native quick-start tutorials.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/content/cardItems.ts | Adds an “Examples” entry to the homepage quick navigation items. |
| src/components/QuickNavigation/index.tsx | Adjusts card grid layout to 3 columns and tweaks heading markup. |
| src/components/QuickNavigation/index.module.css | Updates layout styles to vertically/centrally align card contents. |
| docs/index.mdx | Adds an “Examples” section and updates intro text to mention examples. |
| docs/examples/category.json | Introduces the “Examples” docs category with generated index at /examples. |
| docs/examples/react.mdx | New React (web) runnable examples documentation page. |
| docs/examples/react-native.mdx | New React Native (mobile) runnable examples documentation page. |
| docs/tutorials/react-quick-start.mdx | Adds a “Explore React examples” link in next steps. |
| docs/tutorials/react-native-quick-start.mdx | Adds a “Explore React Native examples” link in next steps. |
| docs/api/category.json | Adjusts sidebar ordering to place API after Examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
## Description Removed some examples but left the necessary ones ## Motivation and Context we created another examples repository to host all of the examples so the ones in here are obsolete ## Documentation impact - [ ] Documentation update required - [x] Documentation updated [in another PR](fishjam-cloud/documentation#240) - [ ] No documentation update required ## Types of changes - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [x] Breaking change (fix or feature that would cause existing functionality to not work as expected) --------- Co-authored-by: adrian <33912477+czerwiukk@users.noreply.github.com>
Description
Added examples for web/mobile/backend to documentation