ci: add GitHub Pages deployment workflow with mdbook-lint

- Add workflow to automatically build and deploy mdBook to GitHub Pages
- Triggers on pushes to main branch when docs change
- Includes mdbook-lint for quality checks on documentation
- Configure book.toml with correct repository URLs and lint settings
- Cache mdbook-lint installation for faster CI runs
- Only deploys on main branch, builds on PRs for validation

Author: joshrotenberg

.github/workflows/mdbook.yml

@@ -0,0 +1,74 @@
+name: Deploy mdBook to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - '.github/workflows/mdbook.yml'
+  pull_request:
+    paths:
+      - 'docs/**'
+      - '.github/workflows/mdbook.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
+        with:
+          fetch-depth: 0
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v2
+        with:
+          mdbook-version: 'latest'
+
+      - name: Cache mdbook-lint
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/bin/mdbook-lint
+          key: mdbook-lint-${{ runner.os }}
+
+      - name: Install mdbook-lint
+        run: |
+          command -v mdbook-lint || cargo install mdbook-lint
+
+      - name: Lint book
+        run: |
+          cd docs
+          mdbook-lint
+
+      - name: Build book
+        run: |
+          cd docs
+          mdbook build
+
+      - name: Upload artifact
+        if: github.event_name != 'pull_request'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/book
+
+  deploy:
+    if: github.event_name != 'pull_request'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/book.toml

@@ -2,15 +2,26 @@
 authors = ["Josh Rotenberg"]
 language = "en"
 src = "src"
-title = "Redis Enterprise API Documentation"
+title = "redisctl Documentation"
 
 [output.html]
 default-theme = "light"
 preferred-dark-theme = "ayu"
-git-repository-url = "https://github.com/joshrotenberg/redis-enterprise-rs"
+git-repository-url = "https://github.com/joshrotenberg/redisctl"
 git-repository-icon = "fa-github"
-edit-url-template = "https://github.com/joshrotenberg/redis-enterprise-rs/edit/main/docs/{path}"
+edit-url-template = "https://github.com/joshrotenberg/redisctl/edit/main/docs/{path}"
 
 [output.html.fold]
 enable = true
 level = 1
+
+[preprocessor.lint]
+command = "mdbook-lint"
+renderer = ["html"]
+
+# mdbook-lint configuration
+[output.lint]
+# Warn about broken links
+warn-on-broken-links = true
+# Warn about unresolved links
+warn-on-unresolved-links = true