Skip to content

Commit

Permalink
[FCE-1017] Fix links in documentation (#80)
Browse files Browse the repository at this point in the history
## Description

Update few links in documentation
  • Loading branch information
mironiasty authored Jan 13, 2025
1 parent 61ec5f3 commit e07dc29
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/react-native/background.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ You can use [`useForegroundService`](/api/mobile/functions/useForegroundService)

:::important[Permissions]

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

Expand Down
4 changes: 2 additions & 2 deletions docs/react/connecting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In order to connect, you need a `PEER_TOKEN` and the `FISHJAM_URL`.
## Connecting

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

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

## Disconnecting

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

```ts
Expand Down
3 changes: 2 additions & 1 deletion docs/react/start-streaming.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ sidebar_position: 3

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

```ts
import { useEffect } from "react";
Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ const config: Config = {
sidebarPath: "./sidebars/docs.ts",
path: "docs",
routeBasePath: "/",
editUrl: "https://github.com/fishjam-cloud/documentation/",
editUrl: "https://github.com/fishjam-cloud/documentation/tree/main/",
remarkPlugins: [
[require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }],
],
Expand Down

0 comments on commit e07dc29

Please sign in to comment.