Release 0.23.0 (#202)

Author: PiotrWodecki

api/fishjam-server

@@ -169,7 +169,7 @@ We can now start sending media, which we can obtain from the user's camera, scre
 
         // Render the livestream
         <LivestreamStreamer
-          whipClientRef={whipClientRef}
+          ref={whipClientRef}
         />
         ```
 

api/room-manager

@@ -1,6 +1,6 @@
 {
   "name": "fishjam-docs",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -19,7 +19,7 @@
     "typecheck": "tsc",
     "format": "prettier . --write",
     "format:check": "prettier . --check",
-    "spellcheck": "cspell '**/*.md' '**/*.mdx' --show-suggestions",
+    "spellcheck": "cspell '**/*.md' '**/*.mdx' --exclude '**/api/**' --show-suggestions",
     "spellcheck:report": "yarn spellcheck --no-show-suggestions"
   },
   "dependencies": {

docs/tutorials/livestreaming.mdx

@@ -0,0 +1,6 @@
+## What is an Agent?
+
+An agent is a piece of software that allows your backend server to participate in a Fishjam room, similar to how the Fishjam client SDKs allow your client-side application to participate in a Fishjam room.
+They can be used to implement features such as real-time audio transcription, real-time content moderation, conversations with AI agents and more.
+
+You can simply think of an agent as a peer running within your backend application.

package.json

@@ -0,0 +1,3 @@
+:::danger Remember to disconnect your agents!
+It's important to disconnect agents, because **every connected agent generates usage** just as a normal peer.
+:::

packages/mobile-client-sdk

@@ -0,0 +1,4 @@
+By default, agents **won't** receive peers' audio streams.
+This is by design and aims to prevent unnecessary resource usage by the agents.
+
+For an agent to start receiving a peer's audio, the peer must be **created** with the **subscribe** option set.

packages/web-client-sdk

@@ -0,0 +1,12 @@
+{
+  "label": "API",
+  "position": 6,
+  "link": {
+    "type": "generated-index",
+    "description": "API documentation for Client and Server SDKs.",
+    "slug": "/api"
+  },
+  "customProps": {
+    "id": "generated-api"
+  }
+}