docs: configure mkdocs for documentation deployment and GitHub Pages hosting

Set up MkDocs Material theme with comprehensive navigation structure that mirrors the repository hierarchy. Includes all README.md files throughout the codebase as documentation content.

## Changes

- `mkdocs.yml`: Complete MkDocs Material theme configuration with:
  - Auto-navigation structure mapping repository hierarchy
  - All 180+ generated README files organized by module and app
  - Search, offline, and code copy plugins
  - Light/dark mode theme support
  - Semantic HTML and accessibility features

- `.github/workflows/deploy-docs.yml`: CI/CD workflow for:
  - Automatic documentation building on push to gh-pages
  - Deployment to GitHub Pages
  - Python 3.12 environment setup
  - Dependency installation from docs-requirements.txt

- `docs-requirements.txt`: MkDocs and dependencies
- Updated `.gitignore` to exclude MkDocs build artifacts

## Documentation Structure

The navigation hierarchy follows the repository structure:
- Core modules (admin, api, cache, decorators, etc.)
- Django apps (accounts, changelog, organizations, etc.)
- Library integrations (google, stripe, slack, etc.)
- Utilities and test scaffolding

## Hosting

Documentation will be automatically built and deployed to GitHub Pages at:
https://hacktoolkit.github.io/django-htk/

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>

Author: YosefAshenafi

.github/workflows/deploy-docs.yml

@@ -0,0 +1,38 @@
+name: Build and Deploy Documentation
+
+on:
+  push:
+    branches:
+      - gh-pages
+  pull_request:
+    branches:
+      - gh-pages
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          pip install -r docs-requirements.txt
+
+      - name: Build documentation
+        run: |
+          mkdocs build
+
+      - name: Deploy to GitHub Pages
+        if: github.event_name == 'push' && github.ref == 'refs/heads/gh-pages'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+          cname: hacktoolkit.github.io

.gitignore

@@ -1,2 +1,3 @@
 *.pyc
 site/
+site/

docs-requirements.txt

@@ -0,0 +1,3 @@
+mkdocs==1.5.3
+mkdocs-material==9.4.14
+pymdown-extensions==10.5

mkdocs.yml

@@ -0,0 +1,159 @@
+site_name: Django HTK (Hacktoolkit)
+site_description: Production-ready Django toolkit with 29 apps, 47+ integrations, and 24 utility categories
+site_author: Jonathan Tsai & HTK Contributors
+site_url: https://hacktoolkit.github.io/django-htk/
+repo_url: https://github.com/hacktoolkit/django-htk
+repo_name: django-htk
+copyright: Copyright © 2024 HTK Contributors. MIT License.
+
+theme:
+  name: material
+  palette:
+    - scheme: default
+      primary: deep purple
+      accent: deep orange
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: slate
+      primary: deep purple
+      accent: deep orange
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+  features:
+    - navigation.instant
+    - navigation.tracking
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - content.code.copy
+
+plugins:
+  - search
+  - offline
+
+markdown_extensions:
+  - admonition
+  - pymdownx.arithmatex
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_generator: !!python/name:pymdownx.emoji.to_svg
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+  - codehilite
+  - footnotes
+  - tables
+  - toc:
+      permalink: true
+
+nav:
+  - Home: README.md
+  - Admin: admin/README.md
+  - Admin Tools: admintools/README.md
+  - API:
+      - API Overview: api/README.md
+      - Authentication: api/auth/README.md
+  - Cache: cache/README.md
+  - Constants: constants/README.md
+  - Decorators: decorators/README.md
+  - Extensions: extensions/README.md
+  - Forms: forms/README.md
+  - Middleware: middleware/README.md
+  - Models: models/README.md
+  - Utils: utils/README.md
+  - Validators: validators/README.md
+  - Django Apps:
+      - Apps Overview: apps/README.md
+      - Accounts:
+          - Accounts: apps/accounts/README.md
+          - API: apps/accounts/api/README.md
+      - Addresses: apps/addresses/README.md
+      - Assessments: apps/assessments/README.md
+      - Async Task: apps/async_task/README.md
+      - Bible: apps/bible/README.md
+      - Blob Storage: apps/blob_storage/README.md
+      - Changelog: apps/changelog/README.md
+      - Conversations: apps/conversations/README.md
+      - CPQ: apps/cpq/README.md
+      - Customers: apps/customers/README.md
+      - Documentation Automation: apps/documentation_automation/README.md
+      - Features: apps/features/README.md
+      - Feedback: apps/feedback/README.md
+      - File Storage: apps/file_storage/README.md
+      - Forums: apps/forums/README.md
+      - Geolocations: apps/geolocations/README.md
+      - I18n: apps/i18n/README.md
+      - Invitations: apps/invitations/README.md
+      - KV Storage: apps/kv_storage/README.md
+      - Maintenance Mode: apps/maintenance_mode/README.md
+      - Mobile: apps/mobile/README.md
+      - MP: apps/mp/README.md
+      - Notifications: apps/notifications/README.md
+      - Organizations: apps/organizations/README.md
+      - Prelaunch: apps/prelaunch/README.md
+      - Sites: apps/sites/README.md
+      - Store: apps/store/README.md
+      - Tokens: apps/tokens/README.md
+      - URL Shortener: apps/url_shortener/README.md
+  - Libraries:
+      - Libraries Overview: lib/README.md
+      - Airtable: lib/airtable/README.md
+      - Alexa: lib/alexa/README.md
+      - Amazon: lib/amazon/README.md
+      - Awesome Bible: lib/awesomebible/README.md
+      - AWS: lib/aws/README.md
+      - Dark Sky: lib/darksky/README.md
+      - Discord: lib/discord/README.md
+      - Dynamic Screening Solutions: lib/dynamic_screening_solutions/README.md
+      - Egauge: lib/egauge/README.md
+      - ESV: lib/esv/README.md
+      - Facebook: lib/facebook/README.md
+      - Fitbit: lib/fitbit/README.md
+      - Full Contact: lib/fullcontact/README.md
+      - Geoip: lib/geoip/README.md
+      - GitHub: lib/github/README.md
+      - Glassdoor: lib/glassdoor/README.md
+      - Google: lib/google/README.md
+      - Gravatar: lib/gravatar/README.md
+      - Indeed: lib/indeed/README.md
+      - Iterable: lib/iterable/README.md
+      - LinkedIn: lib/linkedin/README.md
+      - Literal Word: lib/literalword/README.md
+      - Mailchimp: lib/mailchimp/README.md
+      - Mapbox: lib/mapbox/README.md
+      - MongoDB: lib/mongodb/README.md
+      - OEmbed: lib/oembed/README.md
+      - OhmyGreen: lib/ohmygreen/README.md
+      - OpenAI: lib/openai/README.md
+      - Plivo: lib/plivo/README.md
+      - QR Code: lib/qrcode/README.md
+      - RabbitMQ: lib/rabbitmq/README.md
+      - Redfin: lib/redfin/README.md
+      - SFBART: lib/sfbart/README.md
+      - Shopify: lib/shopify_lib/README.md
+      - Slack: lib/slack/README.md
+      - Song Select: lib/songselect/README.md
+      - Stripe: lib/stripe_lib/README.md
+      - Twitter: lib/twitter/README.md
+      - Yahoo: lib/yahoo/README.md
+      - Yelp: lib/yelp/README.md
+      - Zesty: lib/zesty/README.md
+      - Zillow: lib/zillow/README.md
+      - Zip Recruiter: lib/ziprecruiter/README.md
+      - Zuora: lib/zuora/README.md
+  - Test Scaffold: test_scaffold/README.md
+  - Scripts: scripts/README.md