Skip to content
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.

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

Remove Livepeer Network specific guides from Studio docs section #540

Merged
merged 2 commits into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion ai/contributors/guides/add-model.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ through the steps to add a new model to the AI Subnet.
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
allowFullScreen
></iframe>

## Step-by-Step Guide
Expand Down
2 changes: 1 addition & 1 deletion ai/contributors/guides/add-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ through the steps to add a new pipeline to the AI Subnet.
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
allowFullScreen
></iframe>

## Step-by-Step Guide
Expand Down
33 changes: 0 additions & 33 deletions catalyst/introduction.mdx

This file was deleted.

11 changes: 5 additions & 6 deletions developers/guides/livestream-from-browser.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,14 @@ Livepeer Broadcast React component, or build their own WebRTC solution.
## Using UI Kit Broadcast

The example below show to use the Livepeer UI Kit
[`Broadcast`](/sdks/react/broadcast/Root) component to broadcast from
the web.
[`Broadcast`](/sdks/react/broadcast/Root) component to broadcast from the web.

### Broadcast

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

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

We show some simple styling below with Tailwind CSS, but this can use any
styling library, since the primitives ship as unstyled, composable components.
Expand Down Expand Up @@ -105,8 +104,8 @@ STUN/TURN servers to avoid network firewall issues.
## Adding custom broadcasting

If you want to add custom broadcasting to your app and handle the WebRTC SDP
negotiation without using the React UI Kit primitives, you can follow the steps
below.
negotiation without using the Livepeer React primitives, you can follow the
steps below.

### Get the SDP Host

Expand Down
12 changes: 6 additions & 6 deletions developers/guides/playback-a-livestream.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ play a livestream.
frameborder="0"
width="100%"
height="410"
webkitallowfullscreen
mozallowfullscreen
allowfullscreen
webkitallowFullScreen
mozallowFullScreen
allowFullScreen
/>

### Play Video
Expand Down Expand Up @@ -275,7 +275,7 @@ Looping can also be set with `&loop=true`.
frameborder="0"
width="100%"
height="410"
webkitallowfullscreen
mozallowfullscreen
allowfullscreen
webkitallowFullScreen
mozallowFullScreen
allowFullScreen
/>
12 changes: 6 additions & 6 deletions developers/guides/playback-an-asset.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ styles to demonstrate what's possible.
frameborder="0"
width="100%"
height="410"
webkitallowfullscreen
mozallowfullscreen
allowfullscreen
webkitallowFullScreen
mozallowFullScreen
allowFullScreen
/>

### Play Video
Expand Down Expand Up @@ -268,7 +268,7 @@ set with `&loop=true`.
frameborder="0"
width="100%"
height="410"
webkitallowfullscreen
mozallowfullscreen
allowfullscreen
webkitallowFullScreen
mozallowFullScreen
allowFullScreen
/>
23 changes: 10 additions & 13 deletions developers/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
---
title: Introduction
description: "Explore APIs, guides, and examples to integrate with Livepeer."
description: "Explore APIs, guides, and examples"
icon: "hand-wave"
---

Livepeer is a video infrastructure network for live and on-demand streaming.
Designed to give developers the freedom to innovate, creators autonomy from
platforms, and viewers an incredible, low latency experience.
Livepeer Studio is your home for building, broadcasting, and publishing video
using the Livepeer Network. Effortlessly manage livestreams, video uploads, API
keys, network usage, billing, and more.

<CardGroup cols={2}>
<Card title="Quickstart" href="/developers/quick-start" icon="bolt-lightning">
Get started with Livepeer in less than 5 minutes.
</Card>
<Card title="Core Concepts" href="/developers/core-concepts" icon="file">
Learn about the core concepts of Livepeer.
Get started with Livepeer Studio in less than 5 minutes.
</Card>
<Card title="Guides" href="/developers/guides/overview" icon="book">
Learn how to integrate Livepeer into your app.
Learn how to add live or on-demand streaming into your app.
</Card>
<Card
title="API References"
Expand All @@ -27,10 +24,10 @@ platforms, and viewers an incredible, low latency experience.
</Card>
</CardGroup>

## Explore the Livepeer Dev Kit
## Explore the Livepeer Studio SDKs

The Livepeer Dev Kit is a set of SDKs, pre-built UI components, and tools for
interacting with the Livepeer API.
Explore developer SDKs, pre-built UI components, and tools for interacting with
the Livepeer Studio API.

### Server-side SDKs

Expand All @@ -41,7 +38,7 @@ interacting with the Livepeer API.
<Card title="Python" icon="python" color="#F4DC5E" href="/sdks/python" />
</CardGroup>

### React UI Kit
### React Components

<CardGroup cols={2}>
<Card
Expand Down
4 changes: 2 additions & 2 deletions developers/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ your requests and start building.
In this example, we will use Javascript and React to upload a video. Make sure
to setup a React app first.

## Install the JS SDK and React UI Kit
## Install the JS SDK and Livepeer React

We install both the NodeJS SDK (which works in all JS environments with `fetch`)
and the React UI Kit library, which provides composable React primitives for
and the Livepeer React library, which provides composable React primitives for
building video apps.

```
Expand Down
2 changes: 1 addition & 1 deletion gateways/guides/gateway-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Working knowledge of system adminsitration tasks for your target platform are
required. This guide provides directions for Linux, Windows, and Docker
platforms. Familiarity with Livepeer protocol is beneficial. For more
information view the go Livepeer
[installation guide.](//orchestrators/guides/install-go-livepeer)
[installation guide.](/orchestrators/guides/install-go-livepeer)

This guide was developed using:

Expand Down
99 changes: 12 additions & 87 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -336,12 +336,7 @@
"url": "https://discord.gg/livepeer"
}
],
"versions": [
"Developers",
"Delegators",
"Orchestrators",
"Gateways"
],
"versions": ["Developers", "Delegators", "Orchestrators", "Gateways"],
"topbarCtaButton": {
"name": "Dashboard",
"url": "https://livepeer.studio"
Expand All @@ -357,15 +352,10 @@
"url": "api-reference"
},
{
"name": "Livepeer Dev Kit",
"name": "SDKs",
"icon": "brackets-curly",
"url": "sdks"
},
{
"name": "Catalyst",
"icon": "flask",
"url": "catalyst"
},
{
"name": "AI Video (Alpha)",
"icon": "microchip-ai",
Expand Down Expand Up @@ -435,9 +425,7 @@
{
"group": "Webhooks",
"icon": "bell",
"pages": [
"developers/guides/setup-and-listen-to-webhooks"
]
"pages": ["developers/guides/setup-and-listen-to-webhooks"]
},
{
"group": "Transcode API",
Expand Down Expand Up @@ -520,15 +508,6 @@
],
"version": "Gateways"
},
{
"group": "Catalyst",
"pages": [
"catalyst/introduction",
"catalyst/running-catalyst",
"catalyst/deploying-catalyst",
"catalyst/developing-with-catalyst"
]
},
{
"group": "AI Video",
"pages": [
Expand Down Expand Up @@ -570,18 +549,13 @@
"group": "AI Builders",
"icon": "screwdriver-wrench",
"iconType": "solid",
"pages": [
"ai/builders/get-started",
"ai/builders/showcase"
]
"pages": ["ai/builders/get-started", "ai/builders/showcase"]
},
{
"group": "How to Contribute",
"icon": "heart",
"iconType": "solid",
"pages": [
"ai/contributors/coming-soon"
]
"pages": ["ai/contributors/coming-soon"]
},
{
"group": "AI API Reference",
Expand Down Expand Up @@ -623,60 +597,16 @@
}
]
},
{
"group": "Core Concepts",
"icon": "notes",
"pages": [
{
"group": "Livepeer Primitives",
"pages": [
"developers/core-concepts/core-api/asset",
"developers/core-concepts/core-api/stream",
"developers/core-concepts/core-api/multistream",
"developers/core-concepts/core-api/access-control"
]
},
{
"group": "Livepeer Studio Dashboard",
"pages": [
"developers/core-concepts/studio/webhooks",
"developers/core-concepts/studio/stream-health",
"developers/core-concepts/studio/in-browser-broadcast"
]
},
{
"group": "Livepeer Player",
"pages": [
"developers/core-concepts/player/overview"
]
},
{
"group": "Livepeer Network",
"pages": [
"developers/core-concepts/livepeer-network/delegators",
"developers/core-concepts/livepeer-network/orchestrators",
"developers/core-concepts/livepeer-network/gateways"
]
}
]
},
{
"group": "Overview",
"pages": [
"sdks/introduction"
]
"pages": ["sdks/introduction"]
},
{
"group": "Server-side SDKs",
"pages": [
"sdks/javascript",
"sdks/ruby",
"sdks/go",
"sdks/python"
]
"pages": ["sdks/javascript", "sdks/ruby", "sdks/go", "sdks/python"]
},
{
"group": "React UI Kit",
"group": "React Components",
"icon": "circle-play",
"pages": [
"sdks/react/getting-started",
Expand Down Expand Up @@ -752,10 +682,7 @@
{
"group": "Examples",
"icon": "clipboard",
"pages": [
"sdks/react/Player",
"sdks/react/Broadcast"
]
"pages": ["sdks/react/Player", "sdks/react/Broadcast"]
},
{
"group": "Migration",
Expand Down Expand Up @@ -791,9 +718,7 @@
},
{
"group": "Playback",
"pages": [
"sdks/react/migration/3.x/playback/usePlaybackInfo"
]
"pages": ["sdks/react/migration/3.x/playback/usePlaybackInfo"]
},
{
"group": "Constants",
Expand All @@ -820,7 +745,7 @@
"pages": [
{
"group": "Asset",
"icon": "file-video",
"icon": "video",
"pages": [
"api-reference/asset/overview",
"api-reference/asset/upload",
Expand All @@ -833,7 +758,7 @@
},
{
"group": "Livestream",
"icon": "signal-stream",
"icon": "camera",
"pages": [
"api-reference/stream/overview",
"api-reference/stream/create",
Expand Down