Skip to content

Commit 1ca7150

Browse files
authored
Fce 3087 reorganize docs (#247)
## Reorganized documentation * renamed `Explanations` to `Concepts` * renamed `Concepts/Room types explained` to `Rooms` * renamed `Concepts/Private vs Public Livestreams` to `Livestreams` * removed `How-to Guides/Features` -> contains sections moved either to `How-to Guides/Web & Mobile` or `How-to Guides/Backend` * removed `Troubleshooting` section from `How-to Guides` -> moved the `Video Codecs` section to * moved `Tutorials/Gemini Live integration` to new section `Integrations/` (setting up for the new VAPI section coming in another PR) ### Also * updated docusaurus * updated packages <img width="309" height="986" alt="image" src="https://github.com/user-attachments/assets/02a340f3-5c8b-4eca-945b-a7480b524da0" />
1 parent 3381d3f commit 1ca7150

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+2041
-968
lines changed

api/fishjam-server

api/protos

api/room-manager

docs/examples/react-native.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,4 +178,4 @@ Browse the full source: [video-player on GitHub](https://github.com/fishjam-clou
178178
- Follow the [React Native Quick Start](../tutorials/react-native-quick-start) if you haven't set up a project yet
179179
- Learn how to [handle screen sharing](../how-to/client/screensharing)
180180
- Learn how to [implement background streaming](../how-to/client/background-streaming)
181-
- Learn how to [work with data channels](../how-to/features/text-chat)
181+
- Learn how to [work with data channels](../how-to/client/text-chat)

docs/examples/react.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ yarn dev
4646
The room component uses `usePeers` to retrieve all participants and renders their video streams using `VideoPlayer` and audio with `AudioPlayer`.
4747

4848
:::note
49-
This example requires a **peer token** to connect. You need to obtain one yourself — either via the [Sandbox API](../how-to/features/sandbox-api-testing#step-2-create-a-room-and-get-peer-tokens) for quick testing, or by setting up your own backend with the [Fishjam Server SDK](../tutorials/backend-quick-start).
49+
This example requires a **peer token** to connect. You need to obtain one yourself — either via the [Sandbox API](../how-to/backend/sandbox-api-testing#step-2-create-a-room-and-get-peer-tokens) for quick testing, or by setting up your own backend with the [Fishjam Server SDK](../tutorials/backend-quick-start).
5050
:::
5151

5252
Browse the full source: [minimal-react on GitHub](https://github.com/fishjam-cloud/examples/tree/main/web-react/minimal-react)
@@ -153,7 +153,7 @@ Smelter requires WebAssembly support — use a modern browser.
153153
The `useSmelter` hook manages the Smelter engine lifecycle. `registerInput` connects the local camera feed and `registerOutput` routes the composited result back into Fishjam as a custom track.
154154

155155
:::note
156-
This example requires a **peer token** to connect. You need to obtain one yourself — either via the [Sandbox API](../how-to/features/sandbox-api-testing#step-2-create-a-room-and-get-peer-tokens) for quick testing, or by setting up your own backend with the [Fishjam Server SDK](../tutorials/backend-quick-start).
156+
This example requires a **peer token** to connect. You need to obtain one yourself — either via the [Sandbox API](../how-to/backend/sandbox-api-testing#step-2-create-a-room-and-get-peer-tokens) for quick testing, or by setting up your own backend with the [Fishjam Server SDK](../tutorials/backend-quick-start).
157157
:::
158158

159159
Browse the full source: [minimal-smelter on GitHub](https://github.com/fishjam-cloud/examples/tree/main/web-react/minimal-smelter)
@@ -189,5 +189,5 @@ Browse the full source: [fishjam-chat on GitHub](https://github.com/fishjam-clou
189189
## Next steps
190190

191191
- Follow the [React Quick Start](../tutorials/react-quick-start) if you haven't set up a project yet
192-
- Learn how to [work with data channels](../how-to/features/text-chat)
192+
- Learn how to [work with data channels](../how-to/client/text-chat)
193193
- Learn how to [implement screen sharing](../how-to/client/screensharing)

docs/explanation/_category_.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"label": "Explanation",
3-
"position": 4,
2+
"label": "Concepts",
3+
"position": 5,
44
"link": {
55
"type": "generated-index",
6-
"title": "Explanation",
6+
"title": "Concepts",
77
"description": "Big-picture explanations of higher-level Fishjam concepts. Most useful for building understanding of a particular topic.",
88
"slug": "/explanation"
99
},

docs/explanation/agent-internals.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
type: explanation
33
title: Agent Internals
4-
sidebar_position: 5
4+
sidebar_position: 6
55
description: Deep dive into Fishjam agent architecture, lifecycle, and how to integrate without using a server SDK.
66
---
77

docs/explanation/architecture.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ sequenceDiagram
8181

8282
## Next Steps
8383

84-
To understand different room types in detail, see [Room Types Explained](../explanation/room-types).
84+
To understand different room types in detail, see [Rooms](../explanation/rooms).
8585

8686
To learn about security and token management, see [Security & Token Model](../explanation/security-tokens).
8787

docs/explanation/data-channels.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,4 @@ The typical flow is:
6464
2. Subscribe to incoming messages
6565
3. Publish messages to other peers
6666

67-
For a complete step-by-step guide on implementing text chat, see [Text Chat](../how-to/features/text-chat).
67+
For a complete step-by-step guide on implementing text chat, see [Text Chat](../how-to/client/text-chat).

docs/explanation/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ The ID of your Fishjam instance. It is used by your backend server to add peers
3636

3737
### Sandbox API
3838

39-
A simple testing API allowing you to test Fishjam features without requiring you to add any functionalities to your backend. As the name suggests, it's available **only** in the Sandbox environment. You can find more details [here](/how-to/features/sandbox-api-testing).
39+
A simple testing API allowing you to test Fishjam features without requiring you to add any functionalities to your backend. As the name suggests, it's available **only** in the Sandbox environment. You can find more details [here](/how-to/backend/sandbox-api-testing).

0 commit comments

Comments
 (0)