chore: update documentation structure and build process, replacing MkDocs with static site generation and pdoc for improved site management

Author: SirStig

.devcontainer/OVERVIEW.md

@@ -46,7 +46,7 @@ A complete containerized development environment for YokedCache with Redis, Memc
 ### Development Tools
 - **Pre-commit hooks** for code quality
 - **Coverage reporting** with pytest-cov
-- **Documentation building** with MkDocs
+- **Documentation building** with static HTML (`build_docs_site.py`) and pdoc
 - **CLI tools** for cache management
 - **Development helper script** (`./dev.sh`)
 

.devcontainer/PORT-UPDATE-SUMMARY.md

@@ -57,7 +57,7 @@ redis-cli -h redis -p 56379
 nc -z memcached 11211
 
 # Documentation server
-mkdocs serve --dev-addr=0.0.0.0:58080
+`./dev.sh docs-serve` (static site on port 58080)
 
 # Jupyter Lab
 jupyter lab --ip=0.0.0.0 --port=58888 --allow-root

.devcontainer/README.md

@@ -28,7 +28,7 @@ This directory contains a complete containerized development environment for Yok
 - **VS Code Extensions**: Python, Pylance, Black, isort, flake8, mypy, pytest
 - **Code Quality**: Pre-commit hooks, linting, type checking
 - **Testing**: pytest with coverage reporting
-- **Documentation**: MkDocs for documentation building
+- **Documentation**: Static site via `scripts/build_docs_site.py` and pdoc (`./dev.sh docs`)
 
 ### Optional Monitoring Stack
 - **Redis Insight** (GUI for Redis) - Port 8001

.devcontainer/dev.sh

@@ -92,14 +92,21 @@ case "$1" in
     "docs"|"doc")
         log_info "Building documentation..."
         activate_env
-        mkdocs build
+        pip install -q -e ".[docs]" 2>/dev/null || true
+        python scripts/build_docs_site.py
+        cp CHANGELOG.md site/changelog.md 2>/dev/null || true
+        python -m pdoc yokedcache -o site/api --template-directory site-src/pdoc-template
         log_success "Documentation built in site/"
         ;;
 
     "docs-serve")
         log_info "Starting documentation server..."
         activate_env
-        mkdocs serve --dev-addr=0.0.0.0:58080
+        pip install -q -e ".[docs]" 2>/dev/null || true
+        python scripts/build_docs_site.py
+        cp CHANGELOG.md site/changelog.md 2>/dev/null || true
+        python -m pdoc yokedcache -o site/api --template-directory site-src/pdoc-template
+        cd site && python -m http.server 58080 --bind 0.0.0.0
         ;;
 
     "redis-cli")

.flake8

@@ -0,0 +1,5 @@
+# Flake8 does not read [tool.flake8] from pyproject.toml without a plugin.
+# Keep in sync with [tool.flake8] in pyproject.toml.
+[flake8]
+max-line-length = 88
+extend-ignore = E203, E501, W503

.github/ISSUE_TEMPLATE/bug_report.md

@@ -33,7 +33,7 @@ Paste any error messages or stack traces here
 **Environment (please complete the following information):**
  - OS: [e.g. Ubuntu 20.04, Windows 10, macOS 12]
  - Python version: [e.g. 3.9.5]
- - YokedCache version: [e.g. 0.1.0]
+ - YokedCache version: [e.g. 1.0.0-beta]
  - Redis version: [e.g. 7.0.5]
  - FastAPI version: [e.g. 0.104.1]
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -48,7 +48,7 @@ Describe the tests that have been performed to verify the changes. Include instr
 - [ ] Integration tests pass
 - [ ] Manual testing performed
 - [ ] Performance testing (if applicable)
-- [ ] Documentation builds correctly (`mkdocs build --strict`)
+- [ ] Documentation site builds (`python scripts/build_docs_site.py` after `pip install -e ".[docs]"`)
 
 ### Test Instructions
 

.github/workflows/docs-seo.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
     inputs:
       version:
-        description: 'Version to release (e.g., 0.3.0)'
+        description: 'Version to release (e.g., 1.0.0-beta)'
         required: true
         type: string
       prerelease: