Dev

.gitattributes

@@ -0,0 +1 @@
+docs/*

.github/workflows/deploy-docs.yml

@@ -0,0 +1,57 @@
+name: Deploy VitePress site to Pages
+
+on:
+  push:
+    paths:
+      - "docs/**"
+      - ".github/workflows/deploy-docs.yml"
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        working-directory: docs
+        run: bun install
+
+      - name: Build with VitePress
+        working-directory: docs
+        run: bun run docs:build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -16,3 +16,9 @@ extra/*
 config.toml
 local.config.toml
 .env
+
+# VitePress Docs
+docs/node_modules/
+docs/.vitepress/dist/
+docs/.vitepress/cache/
+

config.example.toml

@@ -19,6 +19,32 @@ tape = { tape_stop = true, tape_stop_duration_ms = 500, curve = "sinusoidal" } #
 # List of mirror provider patterns. %ISRC% or %QUERY%
 providers = ["ytsearch:%ISRC%", "ytsearch:%QUERY%", "scsearch:%QUERY%"]
 
+[player.mirrors.best_match]
+# Enable weighted scoring to find the best-matching candidate.
+# When false, the first resolvable result from each provider is accepted immediately.
+# Default: true
+scoring = true
+
+# Prefixes treated as throttled (rate-sensitive) — tried sequentially after all parallel free providers.
+# Default: ["ytmsearch:", "ytsearch:"]
+throttled_prefixes = ["ytmsearch:", "ytsearch:"]
+
+# Confidence thresholds (only used when scoring = true). All values in [0.0, 1.0].
+# immediate_use   — accept instantly, cancel remaining parallel searches.
+# high_confidence — try up to 2 candidates instead of 3.
+# min_similarity  — discard anything below this score entirely.
+immediate_use   = 0.88
+high_confidence = 0.75
+min_similarity  = 0.50
+
+# Scoring weights (should sum to 1.0).
+weight_title    = 0.50
+weight_artist   = 0.30
+weight_duration = 0.20
+
+# Milliseconds within which two track durations are considered identical.
+duration_tolerance_ms = 3000
+
 [logging]
 level = "info"              # trace | debug | info | warn | error | off
 filters = "rustalink=debug" # e.g. "rustalink=debug,davey=off"

docs/.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+.vitepress/dist
+.vitepress/cache

docs/.vitepress/config.js

@@ -0,0 +1,35 @@
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  title: "Rustalink",
+  description: "High-performance Rust audio server documentation",
+  base: '/Rustalink/',
+  cleanUrls: true,
+  themeConfig: {
+    logo: '/logo.svg',
+    nav: [
+      { text: 'Docs', link: '/' }
+    ],
+    sidebar: [
+      {
+        text: 'Guide',
+        items: [
+          { text: 'Introduction', link: '/' },
+          { text: 'Installation', link: '/guide/installation' },
+          { text: 'Docker', link: '/guide/docker' },
+          { text: 'Configuration', link: '/guide/configuration' },
+          { text: 'Architecture', link: '/guide/architecture' },
+          { text: 'Filters', link: '/guide/filters' },
+          { text: 'REST API', link: '/guide/api' },
+          { text: 'Pterodactyl', link: '/guide/pterodactyl' }
+        ]
+      }
+    ],
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/bongodevs/Rustalink' }
+    ],
+    search: {
+      provider: 'local'
+    }
+  }
+})

docs/.vitepress/theme/index.js

@@ -0,0 +1,9 @@
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+
+export default {
+  extends: DefaultTheme,
+  enhanceApp({ app, router, siteData }) {
+    // Custom enhancements can go here
+  }
+}

docs/.vitepress/theme/style.css

@@ -0,0 +1,31 @@
+:root {
+  --vp-c-brand-1: #FF6A00;
+  --vp-c-brand-2: #D84315;
+  --vp-c-brand-3: #FF8A33;
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #FF6A00 30%, #D84315);
+}
+
+.dark {
+  --vp-c-bg: #0f0f0f;
+  --vp-c-bg-alt: #1a1a1a;
+  --vp-c-bg-elv: #1a1a1a;
+  --vp-c-bg-soft: #1a1a1a;
+
+  --vp-c-text-1: #ffffff;
+  --vp-c-text-2: rgba(255, 255, 255, 0.7);
+
+  --vp-button-brand-bg: #FF6A00;
+  --vp-button-brand-hover-bg: #D84315;
+  --vp-button-brand-active-bg: #D84315;
+}
+
+html {
+  color-scheme: dark !important;
+}
+
+/* Force dark mode */
+body {
+  background-color: var(--vp-c-bg);
+  color: var(--vp-c-text-1);
+}