Skip to content

Commit fff268b

Browse files
authored
FCE-987 improve legibility of quick setup (#81)
## Description As in the title, improves the quick start section.
1 parent 54dda0e commit fff268b

File tree

7 files changed

+34
-32
lines changed

7 files changed

+34
-32
lines changed

docs/react-native/_components/configure-permissions.mdx

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import Tabs from "@theme/Tabs";
22
import TabItem from "@theme/TabItem";
33

4-
Your app must have permissions configured to use the microphone and camera.
4+
Your app needs to have permissions configured in order to use the microphone and camera.
55

66
### Android
77

8-
For android you need to ask for certain permissions:
8+
Permissions below are required to stream audio and video with Fishjam on Android.
99

1010
- `android.permission.CAMERA`
1111
- `android.permission.RECORD_AUDIO`
@@ -15,7 +15,7 @@ For android you need to ask for certain permissions:
1515

1616
<TabItem value="expo" label="Expo">
1717

18-
You need to modify `app.json` file and add all permissions:
18+
Add required permissions to the `app.json` file.
1919

2020
```json title='app.json'
2121
{
@@ -36,7 +36,7 @@ You need to modify `app.json` file and add all permissions:
3636
</TabItem>
3737
<TabItem value="rn" label="Bare workflow">
3838

39-
You need to modify `AndroidManifest.xml` file, and these lines:
39+
Add required permissions to the `AndroidManifest.xml` file.
4040

4141
```xml title='AndroidManifest.xml'
4242
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
@@ -67,8 +67,8 @@ To update default content of permission alert, you can add these settings to `ap
6767
"ios": {
6868
...
6969
"infoPlist": {
70-
"NSCameraUsageDescription": "Your message.",
71-
"NSMicrophoneUsageDescription": "Your message"
70+
"NSCameraUsageDescription": "Allow $(PRODUCT_NAME) to access your camera.",
71+
"NSMicrophoneUsageDescription": "Allow $(PRODUCT_NAME) to access your microphone."
7272
}
7373
},
7474
}
@@ -78,14 +78,13 @@ To update default content of permission alert, you can add these settings to `ap
7878
</TabItem>
7979
<TabItem value="rn" label="Bare workflow">
8080

81-
You need to make sure that `Info.plist` contains these entries:
81+
Ensure `Info.plist` contains camera and microphone usage description entries:
8282

8383
```xml title='Info.plist'
8484
<key>NSCameraUsageDescription</key>
8585
<string>Allow $(PRODUCT_NAME) to access your camera.</string>
8686
<key>NSMicrophoneUsageDescription</key>
87-
<string>Allow $(PRODUCT_NAME) to access your microphone</string>
88-
87+
<string>Allow $(PRODUCT_NAME) to access your microphone.</string>
8988
```
9089

9190
</TabItem>

docs/react-native/_components/install-package.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ npm install @fishjam-cloud/react-native-client
1212

1313
<TabItem value="rn" label="Bare workflow">
1414

15-
#### Install Expo dependencies
15+
### Install Expo dependencies
1616

1717
Follow instructions form official [Expo documentation](https://docs.expo.dev/bare/installing-expo-modules/).
1818

19-
#### Install Fishjam
19+
### Install Fishjam
2020

2121
```sh
2222
npx expo install @fishjam-cloud/react-native-client
2323
```
2424

2525
</TabItem>
26-
26+
2727
</Tabs>

docs/react-native/connecting.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ import TabItem from "@theme/TabItem";
77

88
# Connecting
99

10-
How to connect to Fishjam
10+
This article will guide you through the process of connecting to a Fishjam room.
1111

1212
## Getting URL and token
1313

14-
In order to connect, you need to retrieve URL (multimedia server address) and token (token that will authenticate you in
15-
your Room)
14+
In order to connect, you need to retrieve `FISHJAM_URL` (multimedia server address) and `PEER_TOKEN` (token that will authenticate the peer in
15+
your Room).
1616

1717
<Tabs groupId="app-type">
1818

@@ -35,15 +35,15 @@ const { fishjamUrl, peerToken } = await response.json();
3535
</TabItem>
3636
<TabItem value="production" label="Production App">
3737

38-
For production app, you need to implement your own backend service that will provide user with `peerToken`. To do that,
38+
For production app, you need to implement your own backend service that will provide user with `PEER_TOKEN`. To do that,
3939
follow our [server setup instructions](/production/server).
4040

4141
</TabItem>
4242
</Tabs>
4343

4444
## Connecting
4545

46-
In order to connect, you just need to call [`joinRoom`](/api/mobile/functions/useConnection#joinroom) method with data from previous step:
46+
In order to connect, call [`joinRoom`](/api/mobile/functions/useConnection#joinroom) method with data from previous step:
4747

4848
```tsx
4949
import { useCallback } from "react";
@@ -79,7 +79,7 @@ async function getRoomDetails(roomName: string, peerName: string) {
7979

8080
## Disconnecting
8181

82-
In order to close connection, you have to call [`leaveRoom`](/api/mobile/functions/useConnection#leaveroom) method.
82+
In order to close the connection, you have to call [`leaveRoom`](/api/mobile/functions/useConnection#leaveroom) method.
8383

8484
```tsx
8585
import { useCallback } from "react";

docs/react-native/installation.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ import ConfigurePermissions from "./_components/configure-permissions.mdx";
99

1010
# Installation
1111

12-
How to install package in your mobile app
13-
1412
## Optional: Create new App
1513

1614
<details>

docs/react-native/quick-setup.mdx

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,37 @@ import ConfigurePermissions from "./_components/configure-permissions.mdx";
77

88
# Quick Setup
99

10-
Integrate Fishjam into your React Native application.
10+
This article is a fast track to integrate Fishjam into your React Native application.
11+
It contains all required steps to start streaming video with Fishjam.
12+
You can also [see a full example](#full-example) at the end of the article.
1113

12-
## Install the package
14+
## Prerequisites
15+
16+
In this part, let's focus on all the things you need to prepare to use Fishjam in your project.
17+
18+
### 1. Install the package
1319

1420
<InstallPackage />
1521

16-
## Build native dependencies
22+
### 2. Build native dependencies
1723

1824
```bash
1925
npx expo prebuild
2026
```
2127

22-
## Configure App permissions
28+
### 3. Configure required app permissions
2329

2430
<ConfigurePermissions />
2531

26-
### Get Room Manager URL
27-
28-
Login to [Fishjam Dashboard](https://fishjam.io/app) and get your Room Manager URL.
32+
### 4. Get Room Manager URL
2933

30-
## TL;DR
31-
32-
Checkout [complete example below:](#full-example)
34+
Login to [Fishjam Dashboard](https://fishjam.io/app) and get your [Room Manager](/glossary#room-manager) URL.
3335

3436
## Step by step instructions
3537

38+
Now you are good to jump right into your IDE and integrate Fishjam into your app.
39+
In few simple steps, you will be able to implement a simple video call functionality.
40+
3641
### 1. Fetch peer token
3742

3843
Use your room manager URL to fetch peer token to get a new room:

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"typecheck": "tsc",
1717
"format": "prettier . --write",
1818
"format:check": "prettier . --check",
19-
"spellcheck": "mdspell '**/*.md' '**/*.mdx' '!node_modules/**' '!packages/**' --en-us",
19+
"spellcheck": "mdspell '**/*.md' '**/*.mdx' '!node_modules/**' '!packages/**' '!docs/api/**' --en-us",
2020
"spellcheck:report": "yarn spellcheck -r"
2121
},
2222
"dependencies": {

src/css/custom.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
--ifm-color-primary-lighter: #359962;
1515
--ifm-color-primary-lightest: #3cad6e;
1616
--ifm-code-font-size: 95%;
17-
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
17+
--docusaurus-highlighted-code-line-bg: rgba(255, 255, 255, 0.5);
1818
}
1919

2020
/* For readability concerns, you should choose a lighter palette in dark mode. */

0 commit comments

Comments
 (0)