working dashboard with docs

Author: mahdi-torabi

.github/workflows/docs.yml

@@ -23,10 +23,20 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      - name: Install mkdocs
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs mkdocs-material
+      - name: Build docs with MkDocs
+        run: mkdocs build -d site
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: docs
+          path: site
 
   deploy:
     environment:

.gitignore

@@ -24,4 +24,5 @@ go.work
 .idea
 tests/logs
 logs
-openapi_token
+openapi_token
+site/

Makefile

@@ -72,4 +72,27 @@ release: lint test
 clean:
 	rm -rf ${DIRBASE}/*
 
-.PHONY: all freebsd linux windows docker dep lint test security-tests linux-on-darwin-with-cgo-with-tests release clean
+.PHONY: all freebsd linux windows docker dep lint test security-tests linux-on-darwin-with-cgo-with-tests release clean
+
+# --- Docs helpers -----------------------------------------------------------
+.PHONY: docs-serve docs-build
+
+# Serve docs locally on http://127.0.0.1:8001
+# Prefer MkDocs if installed and mkdocs.yml exists; otherwise, serve static docs/
+docs-serve:
+	@if command -v mkdocs >/dev/null 2>&1 && [ -f mkdocs.yml ]; then \
+		echo "[docs] Serving with MkDocs on http://127.0.0.1:8001"; \
+		mkdocs serve -a 127.0.0.1:8001 || (echo "[docs] MkDocs failed to serve. Falling back to static server" && python3 -m http.server -d docs 8001); \
+	else \
+		echo "[docs] MkDocs not found. Serving static docs/ via Python http.server on http://127.0.0.1:8001"; \
+		python3 -m http.server -d docs 8001; \
+	fi
+
+# Build static site using MkDocs (outputs to site/) if available; otherwise no-op
+docs-build:
+	@if command -v mkdocs >/dev/null 2>&1 && [ -f mkdocs.yml ]; then \
+		echo "[docs] Building MkDocs site into ./site"; \
+		mkdocs build -d site; \
+	else \
+		echo "[docs] MkDocs not installed; skipping build. (Install: pip install mkdocs mkdocs-material)"; \
+	fi