FCE-1661 / improve examples readme#375
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR removes the unmaintained use-camera-and-microphone example and updates the central examples listing with refreshed entries.
- Deleted all files under
examples/react-client/use-camera-and-microphone/ - Updated
examples/react-client/readme.mdto remove the old example and add/adjust other entries - Renamed package in
examples/react-client/livestream-viewer/package.jsonto match its directory
Reviewed Changes
Copilot reviewed 26 out of 38 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| examples/react-client/use-camera-and-microphone/* | Removed unmaintained camera-and-microphone example |
| examples/react-client/readme.md | Refreshed top‐level examples list, removed stale entry |
| examples/react-client/livestream-viewer/package.json | Fixed package name to @fishjam-example/livestream-viewer |
Comments suppressed due to low confidence (2)
examples/react-client/readme.md:1
- Consider renaming this file from
readme.mdtoREADME.mdto match common convention and ensure consistency across the repository.
# Examples for Fishjam client
examples/react-client/readme.md:26
- [nitpick] The
minimal-smelterentry isn't nested under a top-level bullet marker like the other examples. Align its indentation and bullet style to match the surrounding list items.
- [minimal-smelter](./minimal-smelter/) - example of integrating Fishjam with Smelter
PiotrWodecki
approved these changes
Jun 27, 2025
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
Updates README of examples.
Removes an unmaintained example.
Motivation and Context
Readme needed a refresh.
The example of using camera and microphone is covered by the maintained and tested Fishjam Chat example.
Types of changes
not work as expected)