Skip to content

Commit 1ef5f9a

Browse files
rickstaarickstaa
authored
fix: fix broken Studio documentation links (#568)
This commit fixes several broken studio documentation links.
1 parent 88cd03d commit 1ef5f9a

22 files changed

+77
-78
lines changed

‎catalyst/running-catalyst.mdx

+3-5
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,13 @@ docker run \
2929
You will be greeted with a very large amount of spam — give it a minute or so to
3030
boot up. You can then connect to your local box instance:
3131

32-
Address: [http://localhost:8888](http://localhost:8888)
33-
Email: `[email protected]`
34-
Password: `livepeer`
32+
Address: [http://localhost:8888](http://localhost:8888) Email:
33+
`[email protected]` Password: `livepeer`
3534

3635
You can also access the MistServer dashboard to access some underlying
3736
livestreaming infrastructure:
3837

39-
Address: [http://localhost:4242](http://localhost:4242)
40-
Username: `test`
38+
Address: [http://localhost:4242](http://localhost:4242) Username: `test`
4139
Password: `test`
4240

4341
To get you started, the database snapshot includes a few predefined streams.

‎developers/guides/livestream-from-browser.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ Livepeer Broadcast React component, or build their own WebRTC solution.
1111
## Using UI Kit Broadcast
1212

1313
The example below show to use the Livepeer UI Kit
14-
[`Broadcast`](/sdks/livepeer-react/broadcast/Root) component to broadcast from
14+
[`Broadcast`](/sdks/react/broadcast/Root) component to broadcast from
1515
the web.
1616

1717
### Broadcast
1818

1919
This guide assumes you have configured a Livepeer JS SDK client with an API key.
2020

21-
We can use the [`Broadcast`](/sdks/livepeer-react/broadcast/Root) primitives
21+
We can use the [`Broadcast`](/sdks/react/broadcast/Root) primitives
2222
with a stream key, from a stream we created.
2323

2424
We show some simple styling below with Tailwind CSS, but this can use any

‎developers/guides/optimize-latency-of-a-livestream.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ this will necessarily incur transcode latency.
165165
### If you’re using another HLS player, compare your HLS config to the Livepeer Player
166166

167167
Our defaults can be found
168-
[here](https://github.com/livepeer/livepeer-react/blob/47e572880224739f538e75ef192bb290b85a852f/packages/core-web/src/media/browser/hls/index.ts#L55-L61).
168+
[here](https://github.com/livepeer/react/blob/47e572880224739f538e75ef192bb290b85a852f/packages/core-web/src/media/browser/hls/index.ts#L55-L61).
169169
Please note that this config is a starting point that we feel is a good balance
170170
for latency, quality, rebuffering, etc.
171171

‎mint.json

+19-19
Original file line numberDiff line numberDiff line change
@@ -235,79 +235,79 @@
235235
"destination": "/orchestrators/guides/troubleshoot"
236236
},
237237
{
238-
"source": "/reference/livepeer-react",
238+
"source": "/reference/react",
239239
"destination": "/react/getting-started"
240240
},
241241
{
242-
"source": "/reference/livepeer-react/getting-started",
242+
"source": "/reference/react/getting-started",
243243
"destination": "/react/getting-started"
244244
},
245245
{
246-
"source": "/reference/livepeer-react/client",
246+
"source": "/reference/react/client",
247247
"destination": "/react/getting-started"
248248
},
249249
{
250-
"source": "/reference/livepeer-react/LivepeerConfig",
250+
"source": "/reference/react/LivepeerConfig",
251251
"destination": "/sdks/react/migration/3.x/LivepeerConfig"
252252
},
253253
{
254-
"source": "/reference/livepeer-react/Player",
254+
"source": "/reference/react/Player",
255255
"destination": "/react/player/Root"
256256
},
257257
{
258-
"source": "/reference/livepeer-react/Broadcast",
258+
"source": "/reference/react/Broadcast",
259259
"destination": "/react/broadcast/Root"
260260
},
261261
{
262-
"source": "/reference/livepeer-react/providers/studio",
262+
"source": "/reference/react/providers/studio",
263263
"destination": "/sdks/react/migration/3.x/providers/studio"
264264
},
265265
{
266-
"source": "/reference/livepeer-react/asset/useAsset",
266+
"source": "/reference/react/asset/useAsset",
267267
"destination": "/sdks/react/migration/3.x/asset/useAsset"
268268
},
269269
{
270-
"source": "/reference/livepeer-react/asset/useCreateAsset",
270+
"source": "/reference/react/asset/useCreateAsset",
271271
"destination": "/sdks/react/migration/3.x/asset/useCreateAsset"
272272
},
273273
{
274-
"source": "/reference/livepeer-react/asset/useAssetMetrics",
274+
"source": "/reference/react/asset/useAssetMetrics",
275275
"destination": "/sdks/react/migration/3.x/asset/useAssetMetrics"
276276
},
277277
{
278-
"source": "/reference/livepeer-react/asset/useUpdateAsset",
278+
"source": "/reference/react/asset/useUpdateAsset",
279279
"destination": "/sdks/react/migration/3.x/asset/useUpdateAsset"
280280
},
281281
{
282-
"source": "/reference/livepeer-react/stream/useStream",
282+
"source": "/reference/react/stream/useStream",
283283
"destination": "/sdks/react/migration/3.x/stream/useStream"
284284
},
285285
{
286-
"source": "/reference/livepeer-react/stream/useStreamSession",
286+
"source": "/reference/react/stream/useStreamSession",
287287
"destination": "/sdks/react/migration/3.x/stream/useStreamSession"
288288
},
289289
{
290-
"source": "/reference/livepeer-react/stream/useStreamSessions",
290+
"source": "/reference/react/stream/useStreamSessions",
291291
"destination": "/sdks/react/migration/3.x/stream/useStreamSessions"
292292
},
293293
{
294-
"source": "/reference/livepeer-react/stream/useCreateStream",
294+
"source": "/reference/react/stream/useCreateStream",
295295
"destination": "/sdks/react/migration/3.x/stream/useCreateStream"
296296
},
297297
{
298-
"source": "/reference/livepeer-react/stream/useUpdateStream",
298+
"source": "/reference/react/stream/useUpdateStream",
299299
"destination": "/sdks/react/migration/3.x/stream/useUpdateStream"
300300
},
301301
{
302-
"source": "/reference/livepeer-react/playback/usePlaybackInfo",
302+
"source": "/reference/react/playback/usePlaybackInfo",
303303
"destination": "/sdks/react/migration/3.x/playback/usePlaybackInfo"
304304
},
305305
{
306-
"source": "/reference/livepeer-react/constants/abis",
306+
"source": "/reference/react/constants/abis",
307307
"destination": "/sdks/react/migration/3.x/constants/abis"
308308
},
309309
{
310-
"source": "/reference/livepeer-react/constants/contract-addresses",
310+
"source": "/reference/react/constants/contract-addresses",
311311
"destination": "/sdks/react/migration/3.x/constants/contract-addresses"
312312
}
313313
],

‎orchestrators/guides/install-go-livepeer.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ docker pull livepeer/go-livepeer:<RELEASE_VERSION>
127127

128128
Once you've pulled the image, retrieve the image id and start the container.
129129

130-
**Any flags you provide will be passed to the binary**, so you can pass [your configuration](/installation/configuring-livepeer) here.
130+
**Any flags you provide will be passed to the binary**, so you can pass [your configuration flags](/references/go-livepeer/cli-reference) here.
131131

132132
```bash
133133
docker run <image id> <livepeer configuration flags>

‎references/knowledge-base/playback.mdx

+2-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ function PlayerComponent() {
4545

4646
2. If you are using the iframe embedded player, you can add `lowLatency=true` to
4747
the query string. `lvpr.tv/?v={playbackid}&lowLatency=true`
48-
</Card>
48+
49+
</Card>
4950

5051
<Card title="When creating a thumbnail from a live stream, it needs to wait for the first thumbnail to be available. this generally takes less than a min. Then before a dynamic thumbnail is accessible, what is used to show on the player?">
5152
You can use a poster image by default for a player, then, when playback info API returns the thumbnail url, you can start to use dynamic thumbnail for preview.

‎sdks/react/broadcast/Root.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ typical media file playable by an HTML5 video element (MP4, WebM).
7878

7979
Configures the WHIP WebRTC ingest URL for the `Broadcast` component. You can
8080
create the `ingestUrl` by passing
81-
[`getIngest`](/sdks/livepeer-react/broadcast/get-ingest) a string (interpreted
81+
[`getIngest`](/sdks/react/broadcast/get-ingest) a string (interpreted
8282
as a Livepeer Studio stream key or URL), Livepeer Studio stream data, or
8383
Cloudflare stream data. `Broadcast` is compatible with all WHIP playback
8484
endpoints.

‎sdks/react/migration/3.x/Broadcast.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ function BroadcastComponent() {
202202
### theme
203203

204204
Sets the Player-specific theme overrides. It is recommended to use
205-
[`LivepeerConfig`](/sdks/livepeer-react/LivepeerConfig) for any global app styles,
205+
[`LivepeerConfig`](/sdks/react/migration/3.x/LivepeerConfig) for any global app styles,
206206
and the `theme` prop to override those styles on a per-Broadcast basis.
207207

208208
```tsx
@@ -236,7 +236,7 @@ function BroadcastComponent() {
236236
### children
237237

238238
Overrides the custom controls for the Player. See the
239-
[`Broadcast` default controls](https://github.com/livepeer/livepeer-react/blob/main/packages/react/src/components/media/Broadcast.tsx)
239+
[`Broadcast` default controls](https://github.com/livepeer/react/blob/main/packages/react/src/components/media/Broadcast.tsx)
240240
for more details on how the `ControlsContainer` component is used.
241241

242242
This can be used alongside `renderChildrenOutsideContainer` to render the

‎sdks/react/migration/3.x/LivepeerConfig.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ The `LivepeerConfig` component manages configuration for all hooks using
1212

1313
<Tabs>
1414
<Tab title="React">
15-
```tsx
15+
```tsx
1616
import { LivepeerConfig } from '@livepeer/react';
1717
```
18-
18+
1919
The `LivepeerConfig` should wrap all of your pages, so every page can use hooks provided by Livepeer React.
2020

2121
```tsx
@@ -67,7 +67,7 @@ The `LivepeerConfig` component manages configuration for all hooks using
6767

6868
### client
6969

70-
A livepeer [`Client`](/sdks/livepeer-react/client) instance that consists of
70+
A livepeer [`Client`](/sdks/react/migration/3.x/client) instance that consists of
7171
configuration options. Required to connect to a provider.
7272

7373
```tsx

‎sdks/react/migration/3.x/Player.mdx

+10-10
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ described in more detail below in [`poster`](#poster) configuration.
6161

6262
</Tab>
6363
<Tab title="React Native">
64-
```tsx
64+
```tsx
6565
import { Player } from '@livepeer/react-native';
6666
```
6767

@@ -147,9 +147,9 @@ or `useCreateStream`, and the `playbackId` was passed to the viewer.
147147
### playbackId or src
148148

149149
A `playbackId` for an
150-
[asset](https://github.com/livepeer/livepeer-react/blob/main/packages/core/src/types/provider.ts)
150+
[asset](https://github.com/livepeer/react/blob/main/packages/core/src/types/provider.ts)
151151
or
152-
[Stream](https://github.com/livepeer/livepeer-react/blob/main/packages/core/src/types/provider.ts),
152+
[Stream](https://github.com/livepeer/react/blob/main/packages/core/src/types/provider.ts),
153153
or `src`, a media source URL. One of these is required.
154154

155155
#### playbackId
@@ -828,7 +828,7 @@ function PlayerComponent() {
828828
### theme
829829

830830
Sets the Player-specific theme overrides. It is recommended to use
831-
[`LivepeerConfig`](/sdks/livepeer-react/LivepeerConfig) for any global app
831+
[`LivepeerConfig`](/sdks/react/migration/3.x/LivepeerConfig) for any global app
832832
styles, and the `theme` prop to override those styles on a per-Player basis.
833833

834834
```tsx
@@ -865,7 +865,7 @@ function PlayerComponent() {
865865
<Tab title="React">
866866

867867
Overrides the custom controls for the Player. See the
868-
[`Player` default controls](https://github.com/livepeer/livepeer-react/blob/main/packages/react/src/components/media/Player.tsx)
868+
[`Player` default controls](https://github.com/livepeer/react/blob/main/packages/react/src/components/media/Player.tsx)
869869
for more details on how the `ControlsContainer` component is used.
870870

871871
This can be used alongside `renderChildrenOutsideContainer` to render the
@@ -877,7 +877,7 @@ parent elements.
877877
<Tab title="React Native">
878878

879879
Overrides the custom controls for the Player. See the
880-
[React Native `Player` default controls](https://github.com/livepeer/livepeer-react/blob/main/packages/react-native/src/components/media/Player.tsx)
880+
[React Native `Player` default controls](https://github.com/livepeer/react/blob/main/packages/react-native/src/components/media/Player.tsx)
881881
for more details on how the `ControlsContainer` component is used.
882882

883883
This can be used alongside `renderChildrenOutsideContainer` to render the
@@ -893,7 +893,7 @@ parent elements.
893893
Sets the error component that is shown when playback fails due to the stream
894894
being offline. When this component is shown, the Player will retry playback in
895895
the background. This will override the
896-
[`OfflineStreamError` component](https://github.com/livepeer/livepeer-react/blob/main/packages/react/src/components/media/controls/PlaybackDisplayError.tsx).
896+
[`OfflineStreamError` component](https://github.com/livepeer/react/blob/main/packages/react/src/components/media/controls/PlaybackDisplayError.tsx).
897897

898898
```tsx
899899
function PlayerComponent() {
@@ -916,7 +916,7 @@ function PlayerComponent() {
916916

917917
Sets the error component that is shown when playback fails due to an access
918918
control error. This will override the
919-
[`PrivateStreamError` component](https://github.com/livepeer/livepeer-react/blob/main/packages/react/src/components/media/controls/PlaybackDisplayError.tsx).
919+
[`PrivateStreamError` component](https://github.com/livepeer/react/blob/main/packages/react/src/components/media/controls/PlaybackDisplayError.tsx).
920920

921921
```tsx
922922
function PlayerComponent() {
@@ -938,7 +938,7 @@ Sets the error component that is shown when playback fails for a generic reason
938938
(usually this is an intermittent network issue). When this component is shown,
939939
the Player will be retrying playback in the background, with linear backoff.
940940
This will override the
941-
[`GenericError` component](https://github.com/livepeer/livepeer-react/blob/main/packages/react/src/components/media/controls/PlaybackDisplayError.tsx).
941+
[`GenericError` component](https://github.com/livepeer/react/blob/main/packages/react/src/components/media/controls/PlaybackDisplayError.tsx).
942942

943943
```tsx
944944
function PlayerComponent() {
@@ -1044,7 +1044,7 @@ to trigger preloading on upcoming videos, and automatically playing/pausing
10441044
media when it is shown/hidden from the list.
10451045

10461046
See our
1047-
[Expo sample app](https://github.com/livepeer/livepeer-react/tree/main/examples/expo)
1047+
[Expo sample app](https://github.com/livepeer/react/tree/main/examples/expo)
10481048
for a real-world example.
10491049

10501050
#### Usage

‎sdks/react/migration/3.x/asset/useAsset.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ description: "React Hook for retrieving an asset."
44
---
55

66
Hook for retrieving an
7-
[asset](https://github.com/livepeer/livepeer-react/blob/main/packages/core/src/types/provider.ts)
7+
[asset](https://github.com/livepeer/react/blob/main/packages/core/src/types/provider.ts)
88
based on a unique identifier.
99

1010
## Usage
1111

1212
<Tabs>
1313
<Tab title="React">
14-
```tsx
14+
```tsx
1515
import { useAsset } from '@livepeer/react';
1616
```
1717

‎sdks/react/migration/3.x/asset/useAssetMetrics.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Hook for retrieving metrics for an Asset.
99

1010
<Tabs>
1111
<Tab title="React">
12-
```tsx
12+
```tsx
1313
import { useAssetMetrics } from '@livepeer/react';
1414
```
1515

@@ -30,7 +30,7 @@ Hook for retrieving metrics for an Asset.
3030
</Info>
3131

3232
The following examples assume an ID has been created for an asset, and the
33-
[`Player`](/sdks/livepeer-react/Player) is used for playback (with its built-in
33+
[`Player`](/sdks/react/Player) is used for playback (with its built-in
3434
metrics reporting).
3535

3636
```tsx

‎sdks/react/migration/3.x/asset/useCreateAsset.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ at once by passing in an array of `sources`.
1111

1212
<Tabs>
1313
<Tab title="React">
14-
```tsx
14+
```tsx
1515
import { useCreateAsset } from '@livepeer/react';
1616
```
1717
</Tab>
@@ -28,7 +28,7 @@ at once by passing in an array of `sources`.
2828
The asset ID should only be passed to users who are allowed to modify the
2929
asset. **Ensure viewers are only provided with the `playbackId`,** which is a
3030
limited identifier that provides only the ability to stream media using the
31-
[`Player`](/sdks/livepeer-react/Player).
31+
[`Player`](/sdks/react/Player).
3232
</Warning>
3333

3434
The following example shows how an asset can be created with the `mutate`

‎sdks/react/migration/3.x/asset/useUpdateAsset.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ description: "React Hook for updating an asset."
44
---
55

66
Hook for updating an existing
7-
[Asset](https://github.com/livepeer/livepeer-react/blob/main/packages/core/src/types/provider.ts).
7+
[Asset](https://github.com/livepeer/react/blob/main/packages/core/src/types/provider.ts).
88

99
## Usage
1010

1111
<Tabs>
1212
<Tab title="React">
13-
```tsx
13+
```tsx
1414
import { useUpdateAsset } from '@livepeer/react';
1515
```
1616

0 commit comments

Comments
 (0)