Merge pull request #305 from txn2/github-project-improvements

Add CHANGELOG.md and mkdocs documentation site

Author: cjimti

.github/workflows/docs.yml

@@ -0,0 +1,45 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+
+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.x'
+
+      - run: pip install mkdocs-material
+
+      - run: mkdocs build --strict
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/deploy-pages@v4
+        id: deployment

.gitignore

@@ -6,4 +6,5 @@ dist
 vendor
 dist/
 kubefwd
-RELEASE_*
+RELEASE_*
+site/

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to kubefwd are documented in [GitHub Releases](https://github.com/txn2/kubefwd/releases).
+
+Each release includes:
+- Highlights and summary
+- New features
+- Improvements
+- Bug fixes
+- Breaking changes (when applicable)
+
+## Release History
+
+See [all releases](https://github.com/txn2/kubefwd/releases) for detailed changelogs.

mkdocs.yml

@@ -0,0 +1,48 @@
+site_name: kubefwd
+site_url: https://txn2.github.io/kubefwd
+site_description: Bulk port forwarding Kubernetes services for local development
+repo_url: https://github.com/txn2/kubefwd
+repo_name: txn2/kubefwd
+
+theme:
+  name: material
+  palette:
+    - scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: slate
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - navigation.instant
+    - navigation.tracking
+    - navigation.sections
+    - search.highlight
+    - content.code.copy
+
+nav:
+  - Home: index.md
+  - Getting Started: getting-started.md
+  - TUI Guide: tui-guide.md
+  - Configuration: configuration.md
+  - Advanced Usage: advanced-usage.md
+  - Architecture: architecture.md
+  - Troubleshooting: troubleshooting.md
+  - Comparison: comparison.md
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.superfences
+  - admonition
+  - toc:
+      permalink: true
+
+plugins:
+  - search