Skip to content

[FCE-1017] Fix links in documentation #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mironiasty merged 3 commits into from
Jan 13, 2025
Merged

[FCE-1017] Fix links in documentation #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e05fed6
Fix edit links
mironiasty Jan 7, 2025
0004d8d
Fix links to API
mironiasty Jan 7, 2025
c6ae8d1
Merge branch 'main' into fix-links
mironiasty Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/react-native/background.mdx
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading