Use Github Pages for accessing docs

Author: vikin91

.github/workflows/docs.yml

@@ -0,0 +1,63 @@
+name: Docs
+
+on:
+  pull_request:
+    branches: [main, master]
+  push:
+    branches: [main, master]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install docs dependencies
+        run: pip install -r requirements-docs.txt
+
+      - name: Build docs site
+        run: mkdocs build --strict
+
+      - name: Upload built docs artifact
+        if: github.event_name == 'pull_request'
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs-site
+          path: site/
+
+      - name: Setup Pages
+        if: github.event_name != 'pull_request'
+        uses: actions/configure-pages@v5
+
+      - name: Upload Pages artifact
+        if: github.event_name != 'pull_request'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  deploy-docs:
+    if: github.event_name != 'pull_request'
+    needs: build-docs
+    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

mkdocs.yml

@@ -0,0 +1,31 @@
+site_name: Sensor Metrics Analyzer Docs
+site_description: Documentation for sensor-metrics-analyzer
+repo_url: https://github.com/stackrox/sensor-metrics-analyzer
+repo_name: stackrox/sensor-metrics-analyzer
+
+theme:
+  name: material
+
+docs_dir: docs
+
+nav:
+  - Docs Home: README.md
+  - Rules:
+      - Rules Home: rules/README.md
+      - Rule Types and Examples: rules/rule-types.md
+      - Advanced Rule Features: rules/advanced-features.md
+      - Load Detection Rules: rules/load-detection.md
+  - Usage:
+      - TUI Keyboard Shortcuts: usage/tui-shortcuts.md
+  - Developer Guides:
+      - Testing: dev/testing.md
+      - Releasing a New Version: dev/releasing.md
+      - Recording Demos: dev/recording-demos.md
+  - Architecture:
+      - Project Structure: architecture/project-structure.md
+
+markdown_extensions:
+  - tables
+  - admonition
+  - toc:
+      permalink: true

requirements-docs.txt

@@ -0,0 +1,2 @@
+mkdocs>=1.6
+mkdocs-material>=9.5