feat: add documentation with vitepress (#50)

Author: mkbula

.dockerignore

@@ -2,3 +2,4 @@ node_modules
 dist
 .git
 *.md
+docs

.github/workflows/docs.yml

@@ -0,0 +1,46 @@
+name: Docs
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - 'docs/**'
+      - '.github/workflows/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:
+      - uses: actions/checkout@v4
+
+      - uses: oven-sh/setup-bun@v2
+
+      - run: bun install --frozen-lockfile
+
+      - run: bun run docs:build
+
+      - uses: actions/configure-pages@v4
+
+      - 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
+    steps:
+      - uses: actions/deploy-pages@v4
+        id: deployment

.gitignore

@@ -20,3 +20,7 @@ pnpm-lock.yaml
 
 # tests
 coverage/
+
+# docs
+docs/.vitepress/dist
+docs/.vitepress/cache

README.md

@@ -9,6 +9,9 @@ Built with [React](https://react.dev/), [Hono](https://hono.dev/), and [Bun](htt
 [![GitHub License](https://img.shields.io/github/license/Maciejonos/qbitwebui?style=for-the-badge&labelColor=101418&color=abedd5)](https://github.com/Maciejonos/qbitwebui/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/v/release/Maciejonos/qbitwebui?style=for-the-badge&labelColor=101418&color=b9c8da)](https://github.com/Maciejonos/qbitwebui/releases)
 [![Docker Build](https://img.shields.io/github/actions/workflow/status/Maciejonos/qbitwebui/docker.yml?style=for-the-badge&labelColor=101418&color=4EB329&label=build)](https://github.com/Maciejonos/qbitwebui/actions)
+
+**[Documentation](https://maciejonos.github.io/qbitwebui/)** · **[Docker Examples](https://maciejonos.github.io/qbitwebui/guide/docker)** · **[All Features](https://maciejonos.github.io/qbitwebui/guide/features)**
+
 </div>
 
 <div align="center">
@@ -28,7 +31,7 @@ Built with [React](https://react.dev/), [Hono](https://hono.dev/), and [Bun](htt
 </details>
 
 <details>
-<summary><h3>Mobile UI (PWA)</h3></summary>
+<summary><h3>Mobile UI</h3></summary>
 <div align="center">
 <table>
   <tr>
@@ -43,22 +46,22 @@ Built with [React](https://react.dev/), [Hono](https://hono.dev/), and [Bun](htt
 
 - **Multi-instance** - Manage multiple qBittorrent instances from one dashboard
 - **Cross seed** - Automatic cross seed directly in qbitwebui. (experimental)
-- **Instance speed management** - Easily control global/alternative speed limits per instance
 - **Instance statistics** - Overview of all instances with status, speeds, torrent counts
-- **User accounts** - Register/login with secure session management
 - **Prowlarr integration** - Search indexers and send torrents directly to qBittorrent
 - **Real-time monitoring** - Auto-refresh torrent status, speeds, progress
 - **Customizable columns** - Show/hide columns, drag and drop reorder
 - **Torrent management** - Add via magnet/file, set priorities, manage trackers/peers
-- **Organization** - Filter by status, category, tag, or tracker
+- **Organization** - Filter by status, category, tag, or tracker, custom views
 - **Bulk actions** - Multi-select with context menu, keyboard navigation
 - **Themes** - Multiple color themes included
-- **Encrypted storage** - qBittorrent credentials stored with AES-256-GCM
 - **File browser** - Browse and download files from your downloads directory
 - **RSS management** - Define rules, add RSS feeds, manage folders
+- **Network agent** - Speedtest, IP check, DNS diagnostics from qBittorrent's network - check how to set up [Network Agent](https://maciejonos.github.io/qbitwebui/guide/network-agent)
 
 ## Docker
 
+See [Docker section](https://maciejonos.github.io/qbitwebui/guide/docker) for all setup options.
+
 ```yaml
 services:
   qbitwebui:
@@ -85,12 +88,6 @@ services:
     restart: unless-stopped
 ```
 
-Or build locally:
-
-```bash
-docker compose up -d
-```
-
 ## Development
 
 ```bash
@@ -100,19 +97,6 @@ bun install
 bun run dev
 ```
 
-## Environment Variables
-
-| Variable | Required | Default | Description |
-|----------|----------|---------|-------------|
-| `ENCRYPTION_KEY` | Yes | - | Min 32 chars, used to encrypt stored credentials |
-| `PORT` | No | `3000` | Server port |
-| `DATABASE_PATH` | No | `./data/qbitwebui.db` | SQLite database location |
-| `SALT_PATH` | No | `./data/.salt` | Encryption salt file location |
-| `ALLOW_SELF_SIGNED_CERTS` | No | `false` | Set to `true` to allow HTTPS connections to qBittorrent instances with self-signed certificates |
-| `DISABLE_AUTH` | No | `false` | Set to `true` to disable login/registration (guest mode) |
-| `DISABLE_REGISTRATION` | No | `false` | Set to `true` to disable new registrations. Creates default `admin` account on first run (password shown in logs) |
-| `DOWNLOADS_PATH` | No | - | Path to downloads directory to enable file browser |
-
 ## Tech Stack
 
 React 19, TypeScript, Tailwind CSS v4, Vite, TanStack Query, Hono, SQLite, Bun