Skip to content

Commit 549aa0d

Browse files
committed
improve root docs page
1 parent 9c7b4d3 commit 549aa0d

File tree

2 files changed

+34
-25
lines changed

2 files changed

+34
-25
lines changed

app/docs/[[...slug]]/page.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export default async function Page(props: PageProps<'/docs/[[...slug]]'>) {
1818
const MDX = page.data.body;
1919

2020
return (
21-
<DocsPage toc={page.data.toc} full={page.data.full}>
21+
<DocsPage toc={page.data.toc} full={page.data.full} tableOfContent={{style: 'clerk'}}>
2222
<DocsTitle>{page.data.title}</DocsTitle>
2323
<DocsDescription>{page.data.description}</DocsDescription>
2424
<DocsBody>

content/docs/index.mdx

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: Riven
33
description: All in one media management solution
44
---
55

6+
import { Callout } from "fumadocs-ui/components/callout"
7+
import { Tabs, Tab } from "fumadocs-ui/components/tabs"
8+
69
<div align="center">
710
<a href="https://github.com/rivenmedia/riven">
811
<picture>
@@ -59,10 +62,11 @@ description: All in one media management solution
5962
</a>
6063
</div>
6164

62-
!!! riven "Riven"
65+
<Callout type="info">
6366
**Riven** is a powerful media management and streaming solution designed to integrate with various media servers and third-party services. It automates the process of finding, downloading, and organizing media content, making it instantly available for streaming through your preferred media server.
67+
</Callout>
6468

65-
<div className="grid grid-cols-2 cards" markdown="1" style={{ justifyContent: "center" }} id="home-cards">
69+
<div className="grid grid-cols-2 gap-4 cards" markdown="1" style={{ justifyContent: "center" }} id="home-cards">
6670

6771
<div>
6872
⚙️ __Easy Installation__
@@ -93,8 +97,9 @@ description: All in one media management solution
9397

9498
![step-5](/images/onboard/final.png)
9599

96-
!!! warning "**Beta**"
97-
Riven is under active development, we are constantly working on new features and fixing bugs.
100+
<Callout type="warning">
101+
Riven is under active development, we are constantly working on new features and fixing bugs.
102+
</Callout>
98103

99104
Riven streamlines your media consumption experience by:
100105

@@ -115,32 +120,34 @@ Before we begin, we need to set up the required folders and files for Riven.
115120

116121
Grab the `docker-compose.yml` file from the [installation guide](#installation) and then `docker-compose up -d` to start the services.
117122

118-
!!! note
123+
<Callout type="info">
119124
* **Linux**: Riven only supports Linux-based operating systems.
120125
* **Windows**: Riven only supports Windows Subsystem for Linux (WSL) in Windows.
121126
* **Rclone**: Required to mount debrid service. Additionally, Zurg is preferred for Real-Debrid users. [Learn more](https://rclone.org/)
122127
* **Media Server**: Plex, Jellyfin, and Emby are supported.
123128
* **Docker**: Required to run Riven in a containerized environment. [Learn more](https://www.docker.com/)
129+
</Callout>
124130

125-
!!! tip "Debrid Support"
126-
Currently only **Real-Debrid**, **All-Debrid** and **Torbox** are supported. More
131+
<Callout type="tip" title="Debrid Support">
132+
Currently only **Real-Debrid** and **Torbox** are supported. More
127133
services will be added in the future!
134+
</Callout>
128135

129136
---
130137

131138
### Setup Directories
132139

133-
For detailed information on the filesystem and VFS configuration, please refer to the [Filesystem (VFS)](services/filesystem/index.md) page. This page will help you understand how to configure and manage your media library using Riven's virtual filesystem. It will help you understand the mount path configuration and how to properly set up volume mounts in the `docker-compose.yml` file.
140+
For detailed information on the filesystem and VFS configuration, please refer to the [Filesystem (VFS)](docs/services/filesystem/) page. This page will help you understand how to configure and manage your media library using Riven's virtual filesystem. It will help you understand the mount path configuration and how to properly set up volume mounts in the `docker-compose.yml` file.
134141

135142
---
136143

137144
## Installation
138145

139-
!!! danger "Setup VFS Mount Path First! :fire:"
140-
141-
This is incredibly important and must be setup first! When configuring the mount path and library path, you need to make sure that the mount propagation is set up correctly for your system. More information can be found at the [Filesystem (VFS)](services/filesystem/index.md) page.
146+
<Callout type="error" title="Setup VFS Mount Path First! 🔥">
147+
This is incredibly important and must be setup first! When configuring the mount path and library path, you need to make sure that the mount propagation is set up correctly for your system. More information can be found at the [Filesystem (VFS)](docs/services/filesystem) page.
142148

143149
The VFS mount path should be set to the container path (e.g., `/mount`), and proper mount propagation must be configured on the host.
150+
</Callout>
144151

145152
`docker-compose.yml` file is used to run Riven in a containerized environment. It consists of three services:
146153

@@ -237,21 +244,23 @@ Now this won't work as is, you need to modify the `docker-compose.yml` file to m
237244

238245
Depending on how you installed Riven, execute the following command:
239246

240-
=== "Docker"
241-
247+
<Tabs items={['Docker', 'Local']}>
248+
<Tab value="Docker">
242249
```bash
243250
docker-compose up -d && docker-compose logs -f
244251
```
245-
246-
=== "Local"
247-
248-
!!! warning "Python Version"
252+
</Tab>
253+
<Tab value="Local">
254+
<Callout type="warning" title="Python Version">
249255
Riven requires Python 3.11 or higher and `poetry` to be installed.
256+
</Callout>
250257

251258
```bash
252259
poetry install --without dev
253260
poetry run python /src/main.py
254261
```
262+
</Tab>
263+
</Tabs>
255264

256265
You can access the Riven web interface by navigating to the specified `ORIGIN` URL you entered in the `docker-compose.yml` file or your reverse proxy URL.
257266

@@ -309,17 +318,17 @@ At this point you can take a look at the [services](services/index.md) page to l
309318

310319
## Frequently Asked Questions
311320

312-
!!! warning "Cross-site POST form submissions are forbidden"
313-
The most common reason for this is that you may not have set up `ORIGIN`
314-
correctly in the `docker-compose.yml` file. If you are running Riven
315-
behind a reverse proxy, you can remove the `ORIGIN` environment variable
316-
from the `riven-frontend` service.
321+
<Callout type="warn" title="I am seeing CORS errors in the browser console">
322+
Make sure that the `ORIGIN` environment variable in the `riven-frontend` service is set to the correct URL you are accessing the web interface from. If you are running Riven behind a reverse proxy, you can remove the `ORIGIN` environment variable from the `riven-frontend` service.
323+
</Callout>
317324

318-
!!! warning "I am seeing an error when trying to save changes"
325+
<Callout type="warn" title="I am seeing an error when trying to save changes">
319326
If you are seeing an error when trying to save changes, it is most likely due to incorrect configuration or backend failure. Please check the logs of the Riven service to see the error message. If you are unable to resolve the issue, feel free to ask for help in the Riven Discord server.
327+
</Callout>
320328

321-
!!! warning "I am stuck in an onboarding loop"
329+
<Callout type="warn" title="I am stuck in an onboarding loop">
322330
If you are stuck in the onboarding loop, it is most likely due to incorrect symlink settings. Check your library path and rclone mount path. If they are correct, check the logs of the Riven service. If you are unable to resolve the issue, feel free to ask for help in the Riven Discord server.
331+
</Callout>
323332

324333
{/* ## What is Next?
325334

0 commit comments

Comments
 (0)