Merge pull request #46 from bongodevs/dev

Dev

Author: Appu

.github/workflows/deploy-docs.yml

@@ -1,4 +1,4 @@
-name: Deploy VitePress site to Pages
+name: Deploy Astro site to Pages
 
 on:
   push:
@@ -26,23 +26,12 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Setup Bun
-        uses: oven-sh/setup-bun@v1
+      - name: Install, build, and upload your site
+        uses: withastro/action@v5
         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
+          path: ./docs
+          package-manager: bun
+          node-version: 22
 
   deploy:
     environment:

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "rustalink"
-version = "1.0.10"
+version = "1.0.11"
 edition = "2024"
 license = "Apache-2.0"
 authors = ["appujet", "notdeltaxd", "contributors"]

Cargo.toml

@@ -2,7 +2,7 @@
 address = "0.0.0.0"
 port = 2333
 authorization = "youshallnotpass"
-player_update_interval = 100      # ms
+player_update_interval = 5        # seconds
 stats_interval = 30               # seconds
 websocket_ping_interval = 20      # seconds
 max_event_queue_size = 100
@@ -52,6 +52,8 @@ filters = "rustalink=debug" # e.g. "rustalink=debug,davey=off"
 [logging.file]
 path = "./logs/rustalink.log"
 max_lines = 10000
+rotate_daily = false  # when true, creates rustalink-YYYY-MM-DD.log each day
+max_files = 7         # max daily log files to keep (0 = unlimited, only applies when rotate_daily = true)
 
 [route_planner]
 enabled = false

config.example.toml

@@ -1,3 +1,21 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
 node_modules/
-.vitepress/dist
-.vitepress/cache
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store

docs/.gitignore

@@ -0,0 +1,77 @@
+// @ts-check
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+import mdx from '@astrojs/mdx';
+import mermaid from 'astro-mermaid';
+
+// https://astro.build/config
+export default defineConfig({
+  base: '/Rustalink/',
+  redirects: {
+    '/': '/Rustalink/introduction/',
+  },
+  integrations: [
+    starlight({
+      title: 'Rustalink',
+      favicon: '/favicon.svg',
+      description: 'High-performance Rust audio server documentation',
+      customCss: ['./src/style/custom.css'],
+      logo: {
+        src: './src/assets/rastalink.svg',
+      },
+      social: [
+        { icon: 'github', label: 'GitHub', href: 'https://github.com/bongodevs/Rustalink' },
+        { icon: 'discord', label: 'Discord', href: 'https://discord.gg/vzjqrUpWxJ' }
+      ],
+      editLink: {
+        baseUrl: 'https://github.com/bongodevs/Rustalink/edit/main/docs/',
+      },
+      sidebar: [
+        {
+          label: 'Getting Started',
+          items: [
+            { label: 'Introduction', slug: 'introduction' },
+            { label: 'Configuration', slug: 'configuration' },
+            { label: 'Docker', slug: 'docker' },
+            { label: 'Pterodactyl', slug: 'pterodactyl' },
+            { label: 'Troubleshooting', slug: 'troubleshooting' },
+          ],
+        },
+        {
+          label: 'Core Concepts',
+          items: [
+            { label: 'Architecture', slug: 'architecture' },
+            { label: 'Filters', slug: 'filters' },
+            { label: 'Client Libraries', slug: 'clients' },
+          ],
+        },
+        {
+          label: 'Reference',
+          items: [
+            { label: 'REST API', slug: 'api' },
+            {
+              label: 'WebSocket Events',
+              items: [
+                { label: 'Track Start', slug: 'events/track-start' },
+                { label: 'Track End', slug: 'events/track-end' },
+                { label: 'Track Exception', slug: 'events/track-exception' },
+                { label: 'Track Stuck', slug: 'events/track-stuck' },
+                { label: 'WebSocket Closed', slug: 'events/websocket-closed' },
+                {
+                  label: 'Lyrics Events',
+                  items: [
+                    { label: 'Lyrics Found', slug: 'events/lyrics-found' },
+                    { label: 'Lyrics Not Found', slug: 'events/lyrics-not-found' },
+                    { label: 'Lyrics Line', slug: 'events/lyrics-line' },
+                  ],
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    }),
+    mdx({ optimize: true }),
+    mermaid(),
+  ],
+});