Merge pull request #1086 from kernelkit/doc

Switch from GitHub to MkDocs Material for documentation

Signed-off-by: Joachim Wiberg <[email protected]>
Signed-off-by: Jon-Olov Vatn <[email protected]>

Author: troglobit

.github/workflows/build.yml

@@ -24,7 +24,6 @@ on:
         default: kernelkit/infix
         type: string
 
-
   workflow_call:
     inputs:
       target:

.github/workflows/docs.yml

@@ -0,0 +1,73 @@
+name: User Guide Generator
+
+on:
+  push:
+    branches:
+      - doc
+      - main
+    tags:
+      - 'v*'
+    paths:
+      - 'doc/**'
+      - 'mkdocs.yml'
+      - '.github/workflows/docs.yml'
+  pull_request:
+    types: [opened, synchronize, reopened, labeled]
+    paths:
+      - 'doc/**'
+      - 'mkdocs.yml'
+      - '.github/workflows/docs.yml'
+
+permissions:
+  contents: write
+
+concurrency:
+  group: "docs-${{ github.ref }}"
+  cancel-in-progress: false
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          pipx install mkdocs
+          pipx inject mkdocs mkdocs-material
+          pipx inject mkdocs pymdown-extensions
+          pipx inject mkdocs mkdocs-callouts
+          pipx inject mkdocs mike
+          pipx inject mkdocs mkdocs-to-pdf
+          # Workaround, if pipx inject fails to install symlink
+          ln -s "$(pipx environment -V PIPX_LOCAL_VENVS)/mkdocs/bin/mike" \
+                "$(pipx environment -V PIPX_BIN_DIR)/mike" || true
+
+      - name: Configure Git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Deploy dev version
+        if: github.event_name == 'push' && (github.ref == 'refs/heads/doc' || github.ref == 'refs/heads/main')
+        run: |
+          mike deploy --push --update-aliases dev latest
+          mike set-default --push latest
+
+      - name: Deploy tagged version
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+        run: |
+          TAG=${GITHUB_REF#refs/tags/v}
+          # Extract YEAR.MONTH from tag (e.g., v25.06.0-beta1 -> 25.06)
+          VERSION=$(echo $TAG | sed -E 's/^([0-9]+\.[0-9]+)(\.[0-9]+)?(-.*)?$/\1/')
+          echo "Deploying tag $TAG as docs version $VERSION"
+          mike deploy --push --update-aliases $VERSION latest
+          mike set-default --push latest

README.md

@@ -8,12 +8,13 @@ different platforms, simplify long-term maintenance, and provide
 made-easy management using NETCONF, RESTCONF[^2], or the built-in
 command line interface (CLI) from a console or SSH login.
 
-> Click the **▶ Example CLI Session** foldout below for an example, or
-> head on over to the [Infix Documentation](doc/README.md) for more
-> information on how to set up the system.
+> [!TIP]
+> _Curious how it works?_ Click the **▶ Example CLI Session** below to see
+> it in action  
+> — or jump into the comprehensive [Infix Documentation][4] to learn even more.
 
-Although primarily focused on switches and routers, the core values
-may be appealing for other use-cases as well:
+Geared for switches and routers — yet its core value fits plenty of
+other use cases:
 
 - Runs from a squashfs image on a read-only partition
 - Single configuration file on a separate partition
@@ -95,6 +96,7 @@ The [following boards](board/aarch64/README.md) are fully supported:
  - Marvell CN9130 CRB
  - Marvell EspressoBIN
  - Microchip SparX-5i PCB135 (eMMC)
+ - NXP i.MX8MP EVK
  - Raspberry Pi 4B
  - NanoPi R2S
 
@@ -123,16 +125,17 @@ Environments](doc/virtual.md).
 [^1]: An immutable operating system is one with read-only file systems,
     atomic updates, rollbacks, declarative configuration, and workload
     isolation.  All to improve reliability, scalability, and security.
-    For more information, see <https://ceur-ws.org/Vol-3386/paper9.pdf>
-    and <https://www.zdnet.com/article/what-is-immutable-linux-heres-why-youd-run-an-immutable-linux-distro/>.
-
+    For more information, see this [survey paper][5] and [article][6].
 [^2]: Partial RESTCONF support, features like HTTP PATCH, OPTIONS, HEAD,
     and copying between datastores are still missing.
 
-[1]: https://buildroot.org/
-[2]: https://www.sysrepo.org/
+[1]: https://buildroot.org/ "Buildroot Homepage"
+[2]: https://www.sysrepo.org/ "Sysrepo Homepage"
 [3]: doc/cli/introduction.md
-[Latest Build]:    https://github.com/kernelkit/infix/releases/tag/latest
+[4]: https://kernelkit.org/infix/ "Infix User's Guide"
+[5]: https://ceur-ws.org/Vol-3386/paper9.pdf "Immutable Operating Systems: A Survey"
+[6]: https://www.zdnet.com/article/what-is-immutable-linux-heres-why-youd-run-an-immutable-linux-distro/ "Why you should run an immutable Linux distro"
+[Latest Build]:    https://github.com/kernelkit/infix/releases/tag/latest "Latest build"
 [License]:         https://en.wikipedia.org/wiki/GPL_license
 [License Badge]:   https://img.shields.io/badge/License-GPL%20v2-blue.svg
 [GitHub]:          https://github.com/kernelkit/infix/actions/workflows/build.yml/