docs: add basic documentation

.gitignore

@@ -19,3 +19,5 @@
 !/webui/public/download/index.html
 
 .gdb_history
+
+node_modules

docs/.gitignore

@@ -0,0 +1,2 @@
+dist
+cache

docs/.vitepress/config.mts

@@ -0,0 +1,31 @@
+import { defineConfig } from 'vitepress'
+import { en } from './en'
+import { de } from './de'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+    title: "Studio Link - Mix Rooms",
+    description: "Mix Rooms",
+    cleanUrls: true,
+    themeConfig: {
+        socialLinks: [
+            { icon: 'github', link: 'https://github.com/studio-link/mix' },
+            { icon: 'mastodon', link: 'https://social.studio.link/@hallo' }
+        ],
+        search: {
+            provider: 'local'
+        }
+
+    },
+    locales: {
+        root: {
+            label: 'English',
+            ...en
+        },
+        de: {
+            label: 'German',
+            ...de 
+        }
+    }
+
+})

docs/.vitepress/de.ts

@@ -0,0 +1,126 @@
+import { defineConfig, type DefaultTheme } from 'vitepress'
+
+export const de = defineConfig({
+  lang: 'de',
+  description: 'Mix Rooms',
+
+  themeConfig: {
+    nav: nav(),
+
+    sidebar: {
+      '/de/guide/': { base: '/de/hosted/', items: sidebarGuide() },
+      '/de/self-hosted/': { base: '/de/self-hosted/', items: sidebarSelfHosted() }
+    },
+
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © 2013-present IT-Service Sebastian Reimers'
+    }
+  }
+})
+
+function nav(): DefaultTheme.NavItem[] {
+  return [
+    {
+      text: 'Guide',
+      link: '/de/guide/what-is-vitepress',
+      activeMatch: '/guide/'
+    },
+    {
+      text: 'Reference',
+      link: '/de/reference/site-config',
+      activeMatch: '/reference/'
+    },
+    {
+      text: '0.6.0-beta',
+      items: [
+        {
+          text: 'Changelog',
+          link: 'https://github.com/studio-link/mix/blob/main/CHANGELOG.md'
+        }
+      ]
+    }
+  ]
+}
+
+function sidebarGuide(): DefaultTheme.SidebarItem[] {
+  return [
+    {
+      text: 'Introduction',
+      collapsed: false,
+      items: [
+        { text: 'What is VitePress?', link: 'what-is-vitepress' },
+        { text: 'Getting Started', link: 'getting-started' },
+        { text: 'Routing', link: 'routing' },
+        { text: 'Deploy', link: 'deploy' }
+      ]
+    },
+    {
+      text: 'Writing',
+      collapsed: false,
+      items: [
+        { text: 'Markdown Extensions', link: 'markdown' },
+        { text: 'Asset Handling', link: 'asset-handling' },
+        { text: 'Frontmatter', link: 'frontmatter' },
+        { text: 'Using Vue in Markdown', link: 'using-vue' },
+        { text: 'Internationalization', link: 'i18n' }
+      ]
+    },
+    {
+      text: 'Customization',
+      collapsed: false,
+      items: [
+        { text: 'Using a Custom Theme', link: 'custom-theme' },
+        {
+          text: 'Extending the Default Theme',
+          link: 'extending-default-theme'
+        },
+        { text: 'Build-Time Data Loading', link: 'data-loading' },
+        { text: 'SSR Compatibility', link: 'ssr-compat' },
+        { text: 'Connecting to a CMS', link: 'cms' }
+      ]
+    },
+    {
+      text: 'Experimental',
+      collapsed: false,
+      items: [
+        { text: 'MPA Mode', link: 'mpa-mode' },
+        { text: 'Sitemap Generation', link: 'sitemap-generation' }
+      ]
+    },
+    { text: 'Config & API Reference', base: '/reference/', link: 'site-config' }
+  ]
+}
+
+function sidebarSelfHosted(): DefaultTheme.SidebarItem[] {
+  return [
+    {
+      text: 'Reference',
+      items: [
+        { text: 'Site Config', link: 'site-config' },
+        { text: 'Frontmatter Config', link: 'frontmatter-config' },
+        { text: 'Runtime API', link: 'runtime-api' },
+        { text: 'CLI', link: 'cli' },
+        {
+          text: 'Default Theme',
+          base: '/reference/default-theme-',
+          items: [
+            { text: 'Overview', link: 'config' },
+            { text: 'Nav', link: 'nav' },
+            { text: 'Sidebar', link: 'sidebar' },
+            { text: 'Home Page', link: 'home-page' },
+            { text: 'Footer', link: 'footer' },
+            { text: 'Layout', link: 'layout' },
+            { text: 'Badge', link: 'badge' },
+            { text: 'Team Page', link: 'team-page' },
+            { text: 'Prev / Next Links', link: 'prev-next-links' },
+            { text: 'Edit Link', link: 'edit-link' },
+            { text: 'Last Updated Timestamp', link: 'last-updated' },
+            { text: 'Search', link: 'search' },
+            { text: 'Carbon Ads', link: 'carbon-ads' }
+          ]
+        }
+      ]
+    }
+  ]
+}

docs/.vitepress/en.ts

@@ -0,0 +1,90 @@
+import { defineConfig, type DefaultTheme } from 'vitepress'
+
+export const en = defineConfig({
+  lang: 'en-US',
+  description: 'Mix Rooms',
+
+  themeConfig: {
+    nav: nav(),
+
+    sidebar: {
+      '/hosted/': { base: '/hosted/', items: sidebarHosted() },
+      '/self-hosting/': { base: '/self-hosting/', items: sidebarSelfHosted() }
+    },
+
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © 2013-present IT-Service Sebastian Reimers'
+    }
+  }
+})
+
+function nav(): DefaultTheme.NavItem[] {
+  return [
+    {
+      text: 'Get started',
+      link: '/hosted/started',
+      activeMatch: '/hosted/'
+    },
+    {
+      text: 'Open Source',
+      link: '/self-hosting/',
+      activeMatch: '/self-hosting/'
+    },
+    {
+      text: '0.6.0-beta',
+      items: [
+        {
+          text: 'Changelog',
+          link: 'https://github.com/studio-link/mix/blob/main/CHANGELOG.md'
+        }
+      ]
+    }
+  ]
+}
+
+function sidebarHosted(): DefaultTheme.SidebarItem[] {
+  return [
+    {
+      text: 'Introduction',
+      collapsed: false,
+      items: [
+        { text: 'What is Mix Rooms?', link: 'what-is-mix-rooms' },
+        { text: 'Getting Started', link: 'started' },
+      ]
+    },
+  ]
+}
+
+function sidebarSelfHosted(): DefaultTheme.SidebarItem[] {
+  return [
+    {
+      text: 'Reference',
+      items: [
+        { text: 'Site Config', link: 'site-config' },
+        { text: 'Frontmatter Config', link: 'frontmatter-config' },
+        { text: 'Runtime API', link: 'runtime-api' },
+        { text: 'CLI', link: 'cli' },
+        {
+          text: 'Default Theme',
+          base: '/reference/default-theme-',
+          items: [
+            { text: 'Overview', link: 'config' },
+            { text: 'Nav', link: 'nav' },
+            { text: 'Sidebar', link: 'sidebar' },
+            { text: 'Home Page', link: 'home-page' },
+            { text: 'Footer', link: 'footer' },
+            { text: 'Layout', link: 'layout' },
+            { text: 'Badge', link: 'badge' },
+            { text: 'Team Page', link: 'team-page' },
+            { text: 'Prev / Next Links', link: 'prev-next-links' },
+            { text: 'Edit Link', link: 'edit-link' },
+            { text: 'Last Updated Timestamp', link: 'last-updated' },
+            { text: 'Search', link: 'search' },
+            { text: 'Carbon Ads', link: 'carbon-ads' }
+          ]
+        }
+      ]
+    }
+  ]
+}

docs/.vitepress/theme/custom.css

@@ -0,0 +1,5 @@
+:root {
+  --vp-c-brand-1: #EA7400;
+  --vp-c-brand-2: #c66302;
+  --vp-c-brand-3: #EA7400;
+}

docs/.vitepress/theme/index.mts

@@ -0,0 +1,4 @@
+import DefaultTheme from 'vitepress/theme'
+import './custom.css'
+
+export default DefaultTheme

docs/hosted/started.md

@@ -0,0 +1,36 @@
+# Let's get started
+
+The easiest way to use **Studio Link - Mix Rooms** is the hosted version 
+(monthly subscription required).
+
+You need only three simple steps to begin!
+
+## 1. Register a Studio Link Account
+
+If you wan't to use the hosted version you have to register a Account here:
+
+https://my.studio.link/login
+
+## 2. Create a Mix Room
+
+Go to https://my.studio.link/mixrooms and click **New room**
+
+![screenshot of room creation](/create_room.png)
+
+Choose a custom Mix Room URL like. For private usage, use
+a more random URL like "myprivatesecretpodcast42". 
+
+
+## 3. Room Links
+
+![screenshot of room links](/room_links.png)
+
+Now you can share or login with the provides Links:
+
+- The **Hosts** Link gives you full access to the mix room. You can control
+  how can participate...
+
+
+- You can share the **Guests** Link with your podcast guests
+
+- Under the **Download** Link you find all recordings

docs/hosted/what-is-mix-rooms.md

@@ -0,0 +1,14 @@
+# What is Mix Rooms?
+
+**Studio Link - Mix Rooms** is an innovative remote podcasting tool designed to revolutionize the way podcasters collaborate, record, and produce content. This platform caters to the needs of podcasters working from different locations, offering a seamless and feature-rich experience for creating high-quality podcasts remotely.
+
+## Use Cases
+
+- **Remote Podcast Recording Studio**
+
+  Mix Rooms provides a virtual recording studio where hosts, co-hosts, and guests can connect remotely. The tool ensures studio-quality audio recording, capturing each participant's voice with clarity and precision.
+
+- **Real-time Collaboration**
+
+  Foster real-time collaboration during recording sessions with Mix Rooms. 
+  Podcasters can communicate using integrated chat or voice features, enhancing teamwork and connection irrespective of geographical distances.

docs/index.md

@@ -0,0 +1,23 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: "Studio Link"
+  text: "Mix Rooms"
+  tagline: Remote Cloud Podcasting and Live Video/Audio conversations with your audience
+  actions:
+    - theme: brand
+      text: Get started
+      link: /hosted/started
+    - theme: alt
+      text: Self-Hosting Guide 
+      link: /self-hosting/
+
+features:
+  - title: Realtime Communication
+    details: Bring the community onto your virtual stage or into the podcast
+  - title: Open Source
+    details: No secrets, the code is available for free forever
+---
+