Skip to content

Commit e07dc29

Browse files
authored
[FCE-1017] Fix links in documentation (#80)
## Description Update few links in documentation
1 parent 61ec5f3 commit e07dc29

File tree

4 files changed

+6
-5
lines changed

4 files changed

+6
-5
lines changed

docs/react-native/background.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ You can use [`useForegroundService`](/api/mobile/functions/useForegroundService)
6565

6666
:::important[Permissions]
6767

68-
If you want to use [`enableCamera`](/api/mobile/functions/useForegroundService#enablecamera) or [`enableMicrophone`](/api/mobile/functions/useForegroundService#enablemicrophone),
68+
If you want to use [`enableCamera`](/api/mobile/type-aliases/ForegroundServiceConfig#enablecamera) or [`enableMicrophone`](/api/mobile/type-aliases/ForegroundServiceConfig#enablemicrophone),
6969
user must first grant permission for this resource. [`useForegroundService`](/api/mobile/functions/useForegroundService) will check if permission is
7070
granted and only then allow to start a service.
7171

docs/react/connecting.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ In order to connect, you need a `PEER_TOKEN` and the `FISHJAM_URL`.
1111
## Connecting
1212

1313
Use the [`useConnection`](/api/web/functions/useConnection) hook to get
14-
the [`joinRoom`](/api/web/functions/useConnection#joinroom) function.
14+
the [`joinRoom`](/api/web/interfaces/UseConnectionResult#joinroom) function.
1515

1616
```tsx
1717
import { useConnection } from "@fishjam-cloud/react-client";
@@ -35,7 +35,7 @@ export function JoinRoomButton() {
3535

3636
## Disconnecting
3737

38-
In order to close connection, use the [`leaveRoom`](/api/web/functions/useConnection#leaveroom) method
38+
In order to close connection, use the [`leaveRoom`](/api/web/interfaces/UseConnectionResult#leaveroom) method
3939
from [`useConnection`](/api/web/functions/useConnection) hook.
4040

4141
```ts

docs/react/start-streaming.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ sidebar_position: 3
88

99
Fishjam provides an API to browse and manage media devices you can use.
1010
To ask the browser for permission to list the available devices,
11-
call the [`initializeDevices`](/api/web/functions/useInitializeDevices#initializedevices) function.
11+
call the [`initializeDevices`](/api/web/type-aliases/UseInitializeDevicesResult#initializedevices)
12+
function from [`useInitializeDevices`](/api/web/functions/useInitializeDevices) hook.
1213

1314
```ts
1415
import { useEffect } from "react";

docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ const config: Config = {
8282
sidebarPath: "./sidebars/docs.ts",
8383
path: "docs",
8484
routeBasePath: "/",
85-
editUrl: "https://github.com/fishjam-cloud/documentation/",
85+
editUrl: "https://github.com/fishjam-cloud/documentation/tree/main/",
8686
remarkPlugins: [
8787
[require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }],
8888
],

0 commit comments

Comments
 (0)