From 74de15af8a382788da7a76c59b1cef33b2d4595e Mon Sep 17 00:00:00 2001
From: "google-labs-jules[bot]"
 <161369871+google-labs-jules[bot]@users.noreply.github.com>
Date: Sun, 2 Nov 2025 15:08:34 +0000
Subject: [PATCH] feat: Add MkDocs site and deployment workflow

This commit introduces a documentation website built with MkDocs and the Material theme.

Key changes:
- Added a `mkdocs.yml` configuration file.
- Renamed `docs/README.md` to `docs/index.md` to serve as the site's homepage.
- Created a GitHub Actions workflow (`.github/workflows/mkdocs.yml`) to automatically build and deploy the site to GitHub Pages on pushes to the `main` branch.
---
 .github/workflows/mkdocs.yml | 15 +++++++++++++++
 docs/{README.md => index.md} |  0
 mkdocs.yml                   |  4 ++++
 3 files changed, 19 insertions(+)
 create mode 100644 .github/workflows/mkdocs.yml
 rename docs/{README.md => index.md} (100%)
 create mode 100644 mkdocs.yml

diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
new file mode 100644
index 0000000..74b7b44
--- /dev/null
+++ b/.github/workflows/mkdocs.yml
@@ -0,0 +1,15 @@
+name: mkdocs
+on:
+  push:
+    branches:
+      - main
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force
diff --git a/docs/README.md b/docs/index.md
similarity index 100%
rename from docs/README.md
rename to docs/index.md
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..b22daf7
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,4 @@
+site_name: Borg Data Collector
+repo_url: https://github.com/Snider/Borg
+theme:
+  name: material