docs: cleanup README.md and add docs site (#166)

* docs: cleanup README.md and add docs site

* docs: formatting

Author: ludviglundgren

.github/workflows/docs.yml

@@ -0,0 +1,53 @@
+name: Deploy docs
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - "docs/**"
+      - ".github/workflows/docs.yml"
+  workflow_dispatch:
+
+# Allow the workflow to deploy to GitHub Pages.
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment, without cancelling in-progress runs.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build site
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+
+      # Enables GitHub Pages for the repo on first run, so no manual
+      # "Settings -> Pages -> Source: GitHub Actions" step is required.
+      - name: Setup Pages
+        uses: actions/configure-pages@v6
+        with:
+          enablement: true
+
+      - name: Build with Astro
+        uses: withastro/action@v6
+        with:
+          path: ./docs
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

.github/workflows/release.yml

@@ -31,6 +31,32 @@ jobs:
       - name: Test
         run: go test -v ./...
 
+  docs:
+    name: Check generated docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+
+      - name: Set up Go
+        uses: actions/setup-go@v6
+        with:
+          go-version: ${{ env.GO_VERSION }}
+          cache: true
+
+      - name: Generate docs
+        run: make docs
+
+      - name: Verify docs are up to date
+        run: |
+          # Use porcelain so newly added (untracked) command pages are caught too.
+          if [ -n "$(git status --porcelain -- docs/src/content/docs/commands)" ]; then
+            echo "::error::Generated command docs are out of date. Run 'make docs' and commit the result."
+            git status --porcelain -- docs/src/content/docs/commands
+            git diff -- docs/src/content/docs/commands
+            exit 1
+          fi
+
   build:
     name: Build Go binaries
     needs: [ test ]

.qbt.toml.example

@@ -1,5 +1,6 @@
 [qbittorrent]
 addr       = "http://127.0.0.1:6776" # qbittorrent webui-api hostname/ip
+#apikey    = "APIKEY"                # qbittorrent webui-api api key, qbit 5.2.x+ (optional)
 login      = "user"                  # qbittorrent webui-api user (optional)
 password   = "password"              # qbittorrent webui-api password (optional)
 #basicUser = "user"                  # qbittorrent webui-api basic auth user (optional)

Makefile

@@ -1,5 +1,10 @@
+.PHONY: deps build docs
+
 deps:
 	go mod tidy
 
 build:
-	go build -o bin/qbt cmd/qbt/main.go
+	go build -o bin/qbt cmd/qbt/main.go
+
+docs:
+	go run ./tools/gen-docs