Conversation
Member
Author
|
Closing per project decision: the full @fishjam-cloud/composition usage guide (FCE-2925) will live in the documentation site (documentation.fishjam.io) as part of the new Smelter Cloud section, not in the package README. Keeping the package README minimal. |
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.
What
Expands the
@fishjam-cloud/compositionpackage README (previously a one-line stub) into a full usage guide.Where
packages/composition/README.mdinjs-server-sdk.Chose the package README because that is where the code lives and it matches the repo convention — every package here has a README, and the sibling
composition-cliREADME already carries real usage docs. Thedocumentation/websiteDocusaurus sites have no composition/smelter pages yet, so nothing to extend there.Contents
composition-cli init, or manual).usePeers()+ SmelterTiles/InputStream.usePeers/usePeer/useRoom/useSpeakingState, thePeerWithStreamsrole split (cameraStream/screenShareStream/customStreams), theStream/TrackStateshape, active-speaker example, and theeventBusfor custom events../core(compositionStore/CompositionStoreFeed) noted as not-for-template-authors.composition-cli(single ESMdist/App.js, allowed-imports contract, default-export + size validation).Everything is grounded in the package source (
hooks.ts,types.ts,store.ts,eventBus.ts,index.ts), the CLI (init.ts,build.ts,validate.ts,smoke.ts,manifests/v1.ts), and the@swmansion/smelterexports — no invented APIs.Open questions
composition-clinot onmainyet. This branch is based onorigin/main, where thecomposition-clipackage isn't merged. The guide references it by npm name (no broken repo-relative links) since it ships alongside; if it should stay on a feature branch, the build section may need adjusting.documentationDocusaurus site (e.g.docs/how-to/backend/)? Left out for now since there's no existing composition/smelter section to match.