docs: add mdBook user guide and Pages publishing (#1)

* docs: add user guide design

* chore: ignore local worktrees

* chore: finalize crate licensing and ignore rules

* docs: add mdbook skeleton

* docs: port discretized grid user guide

* docs: port remaining user guide chapters

* ci: validate mdbook user guide

* docs: publish mdbook user guide

Author: shinaoka

.github/workflows/CI.yml

@@ -46,11 +46,32 @@ jobs:
       - name: Run tests
         run: cargo nextest run --release
 
+  docs:
+    name: Docs
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - uses: Swatinem/rust-cache@v2
+
+      - name: Install mdBook
+        run: cargo install mdbook --no-default-features --features search --vers "^0.5" --locked
+
+      - name: Verify executable book examples
+        run: ./scripts/test-book-examples.sh
+
+      - name: Build mdBook
+        run: mdbook build
+
   rollup:
     runs-on: ubuntu-latest
     needs:
       - lint
       - test
+      - docs
     if: always()
     steps:
       - name: All checks passed

.github/workflows/docs-pages.yml

@@ -0,0 +1,57 @@
+name: Docs Pages
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: docs-pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build docs artifact
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - uses: Swatinem/rust-cache@v2
+
+      - name: Install mdBook
+        run: cargo install mdbook --no-default-features --features search --vers "^0.5" --locked
+
+      - name: Verify executable book examples
+        run: ./scripts/test-book-examples.sh
+
+      - name: Build mdBook
+        run: mdbook build
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: book
+
+  deploy:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1 +1,4 @@
 /target
+.worktrees/
+/book
+/Cargo.lock