From f747f3841581ecac88195d9c5e68742232780981 Mon Sep 17 00:00:00 2001 From: azurejelly <178000437+azurejelly@users.noreply.github.com> Date: Thu, 16 Oct 2025 10:00:15 -0400 Subject: [PATCH] [no ci] docs: add index at the top of each page --- docs/DOCKER.md | 3 +++ docs/FAQ.md | 6 ++++++ docs/GETTING_STARTED.md | 12 +++++++++++- 3 files changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/DOCKER.md b/docs/DOCKER.md index 20a008c..957f450 100644 --- a/docs/DOCKER.md +++ b/docs/DOCKER.md @@ -2,6 +2,9 @@ This file covers how to run VERT under a Docker container. +- [Manually building the image](#manually-building-the-image) +- [Using an image from the GitHub Container Registry](#using-an-image-from-the-github-container-registry) + ### Manually building the image First, clone the repository: ```shell diff --git a/docs/FAQ.md b/docs/FAQ.md index 1eaa773..e589248 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -2,6 +2,12 @@ This file covers frequently asked questions. +- [Why VERT?](#why-vert) +- [What happens with video files?](#what-happens-with-video-files) +- [Can I host my own video file converter?](#can-i-host-my-own-video-file-converter) +- [What about analytics?](#what-about-analytics) +- [What libraries does VERT use?](#what-libraries-does-vert-use) + ### Why VERT? **File converters have always disappointed us.** They're ugly, riddled with ads, and most importantly; slow. We decided to solve this problem once and for all by making an alternative that solves all those problems, and more. diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index c3537ba..0eee2b0 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -2,6 +2,12 @@ This file covers how to get started with VERT. +- [Prerequisites](#prerequisites) +- [Installation](#installation) +- [Running Locally](#running-locally) +- [Building for Production](#building-for-production) +- [Using Docker](#using-docker) + ### Prerequisites Make sure you have the following installed: - [Bun](https://bun.sh/) @@ -35,4 +41,8 @@ PUB_VERTD_URL=https://vertd.vert.sh # default vertd instance To build the project for production, run `bun run build`. -This will build the site to the `build` folder. You should then use a web server like [nginx](https://nginx.org) to serve the files inside that folder. \ No newline at end of file +This will build the site to the `build` folder. You should then use a web server like [nginx](https://nginx.org) to serve the files inside that folder. + +### Using Docker + +Check the dedicated [Docker](./DOCKER.md) page. \ No newline at end of file