Add GitHub Pages docs workflow and clarify pip/docs usage

Author: DennisWayo

.github/workflows/docs.yml

@@ -0,0 +1,54 @@
+name: docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - ".github/workflows/docs.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
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install docs dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -r docs/requirements.txt
+
+      - name: Build docs
+        run: mkdocs build --strict
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -16,7 +16,7 @@ includes CSS and LDPC engine paths for comparative studies.
 Install from PyPI:
 
 ```bash
-pip install lidmas
+python -m pip install --upgrade lidmas
 ```
 
 Then run:
@@ -25,6 +25,11 @@ Then run:
 lidmas --help
 ```
 
+Documentation:
+
+- GitHub Pages: https://denniswayo.github.io/lidmas_cpp/
+- Read the Docs: https://lidmas-cpp.readthedocs.io/
+
 ## Statement of Need
 
 Benchmarking decoder behavior and threshold trends requires reproducible, scriptable,
@@ -221,7 +226,7 @@ For quick validation in local or CI environments:
 
 ## Hardware Integration
 
-See [docs/hardware-integration.md](/Users/denniswayo/lidmas_cpp/docs/hardware-integration.md) for the decoder IO schema,
+See [docs/hardware-integration.md](docs/hardware-integration.md) for the decoder IO schema,
 recommended data transport, and adapter API.
 
 ## Project Layout
@@ -241,7 +246,7 @@ GitHub Releases.
 
 If you use LiDMaS+ in academic work, cite the software release used for your
 experiments (tag + commit hash). If a JOSS/arXiv record is available for your
-release, cite that record directly.
+release, please cite that record directly.
 
 Paper reference (`paper_01`):
 

docs/readthedocs-setup.md

@@ -30,3 +30,16 @@ Docs will be available at `http://127.0.0.1:8000`.
 - Any push that changes docs or config will trigger a new RTD build once the project is connected.
 - Keep command examples in docs aligned with `README.md` and `--help` output.
 
+## GitHub Pages (also supported)
+
+This repository also deploys docs with GitHub Pages via `.github/workflows/docs.yml`.
+
+In repository settings:
+
+1. Go to `Settings -> Pages`.
+2. Set `Source` to `GitHub Actions`.
+3. Push to `main` (or run the `docs` workflow manually).
+
+Published URL:
+
+- `https://denniswayo.github.io/lidmas_cpp/`

mkdocs.yml

@@ -1,6 +1,6 @@
 site_name: LiDMaS+
 site_description: Logical Injection & Decoding Modeling System
-site_url: https://lidmas-cpp.readthedocs.io/
+site_url: https://denniswayo.github.io/lidmas_cpp/
 repo_url: https://github.com/DennisWayo/lidmas_cpp
 repo_name: DennisWayo/lidmas_cpp
 docs_dir: docs
@@ -21,6 +21,6 @@ nav:
   - CLI Reference: cli-reference.md
   - Examples & Workflows: examples-workflows.md
   - Architecture: architecture.md
+  - Hardware Integration: hardware-integration.md
   - Reproducibility & Citation: reproducibility-citation.md
   - Read the Docs Setup: readthedocs-setup.md
-