feat: Add mdbook page generation and preview

Author: AliwiWalid

.github/workflows/book-preview.yaml

@@ -0,0 +1,32 @@
+name: mdBook PR Preview
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, closed]
+    paths:
+      - "docs/**"
+      - ".github/workflows/preview-mdbook.yml"
+
+permissions:
+  contents: write
+  pull-requests: write
+
+concurrency: preview-${{ github.ref }}
+
+jobs:
+  deploy-preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install mdBook
+        run: cargo install mdbook
+
+      - name: Build mdBook
+        run: mdbook build docs
+
+      - name: Deploy PR Preview
+        uses: rossjrw/pr-preview-action@v1.4.7
+        with:
+          source-dir: docs/book
+          umbrella-dir: docs/pr-preview

.github/workflows/deploy-mdbook.yml

@@ -0,0 +1,45 @@
+name: Documentation Deploy
+
+on:
+  # When a PR is merged (or force push to main)
+  push:
+    branches: ["main"]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Enable cargo logs to be in colour
+env:
+  CARGO_TERM_COLOR: always
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build-mdbook:
+    name: Build and Deploy mdBook
+    environment:
+      name: github-pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install mdBook
+        run: cargo install mdbook --locked
+
+      - name: Build the book
+        run: mdbook build docs
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4.0.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/book
+          publish_branch: gh-pages
+          destination_dir: ./main/

Makefile

@@ -4,17 +4,25 @@
 
 .PHONY: ci-job-format
 ci-job-format:
-	@echo "Checking formating of source files..."
+	@echo "Checking formatting of source files..."
 	@./tools/run_fmt_check.sh
 
 .PHONY: ci-job-clippy
 ci-job-clippy:
 	@echo "Running clippy on source files..."
 	@./tools/run_clippy.sh
 
+.PHONY: ci-job-mdbook
+ci-job-mdbook:
+	@echo "Generating book.toml..."
+	@echo "Installing mdBook"
+	@which mdbook >/dev/null 2>&1 || cargo install mdbook --locked
+	@echo "Building docs"
+	@mdbook build docs
+
 .PHONY: ci-runner-github
-ci-runner-github: ci-job-format ci-job-clippy
+ci-runner-github: ci-job-format ci-job-clippy ci-job-mdbook
 	@echo "Running cargo check..."
 	@cargo check
 	@echo "Running tests..."
-	@cargo test
+	@cargo test

docs/.gitignore

@@ -0,0 +1 @@
+book

docs/book.toml

@@ -0,0 +1,5 @@
+[book]
+authors = ["Tockloader-rs Contributors"]
+language = "en"
+src = "src"
+title = "Tockloader-rs Dev Notes"

docs/src/SUMMARY.md

@@ -0,0 +1,14 @@
+# Summary
+
+- [Introduction](intro.md)
+
+- [Tockloader-rs Commands](commands/index.md)
+  - [Listen](commands/listen.md)
+  - [Info](commands/info.md)
+  - [List](commands/list.md)
+  - [Install](commands/install.md)
+
+- [Tock Concepts](concepts/index.md)
+  - [TBF Headers](concepts/tbf_headers.md)
+  - [Bootloader](concepts/bootloader.md)
+  - [Bootloader Attributes](concepts/bootloader_attributes.md)