From e07dc29af3bb3552b0138ac740e6d676bdc432ba Mon Sep 17 00:00:00 2001 From: Miron Pawlik Date: Mon, 13 Jan 2025 08:42:59 +0100 Subject: [PATCH] [FCE-1017] Fix links in documentation (#80) ## Description Update few links in documentation --- docs/react-native/background.mdx | 2 +- docs/react/connecting.mdx | 4 ++-- docs/react/start-streaming.mdx | 3 ++- docusaurus.config.ts | 2 +- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/react-native/background.mdx b/docs/react-native/background.mdx index 667acfd..7564080 100644 --- a/docs/react-native/background.mdx +++ b/docs/react-native/background.mdx @@ -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. diff --git a/docs/react/connecting.mdx b/docs/react/connecting.mdx index db39ad6..ac690c0 100644 --- a/docs/react/connecting.mdx +++ b/docs/react/connecting.mdx @@ -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"; @@ -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 diff --git a/docs/react/start-streaming.mdx b/docs/react/start-streaming.mdx index a377dd7..e2dea16 100644 --- a/docs/react/start-streaming.mdx +++ b/docs/react/start-streaming.mdx @@ -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"; diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 277f3e8..fe8150b 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -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 }], ],