feat: Add comprehensive MkDocs documentation with GitHub Pages auto-deployment

This commit implements a complete documentation infrastructure:

**MkDocs Setup:**
- Configured mkdocs.yml with Material theme
- Professional styling with dark/light mode toggle
- Full-text search with suggestions
- Code copy buttons and syntax highlighting
- Enhanced navigation with tabs and expandable sections
- Git revision dates for "Last Updated" info

**Documentation Structure (25 files):**
- Hierarchical docs/ folder mirroring repository structure
- Components: Dialogs, Confirm dialog
- Features: App Settings, Theme system, Device Info
- Utilities: String, Enum, Observer, React Context, Theme, etc.
- Storages: MMKV, localStorage
- States: State management documentation
- Types: TypeScript definitions

**GitHub Pages Automation:**
- GitHub Actions workflow (deploy-docs.yml)
- Triggers on push to master or manual workflow_dispatch
- Monitors changes to docs/, mkdocs.yml, and .md files
- Automatically builds and deploys to gh-pages branch
- Published at: https://hacktoolkit.github.io/expo-htk/

**Developer Tools:**
- requirements-docs.txt for Python dependencies
- docs/BUILD.md with local development instructions
- .gitignore to exclude build artifacts
- .coderabbit.yaml to minimize documentation review noise

The documentation system is now ready for local development and automatic publishing.

🤖 Generated with Claude Code

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

Author: YosefAshenafi

.github/workflows/deploy-docs.yml

@@ -0,0 +1,54 @@
+name: Deploy Documentation to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - '**.md'
+      - '.github/workflows/deploy-docs.yml'
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pages: write
+      id-token: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized pymdown-extensions
+
+      - name: Build documentation
+        run: mkdocs build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+          cname: expo-htk-docs.example.com
+          force_orphan: false
+
+      - name: Create deployment status
+        if: always()
+        run: |
+          echo "Documentation deployment status: ${{ job.status }}"
+          echo "Build completed at: $(date -u +'%Y-%m-%dT%H:%M:%SZ')"

.gitignore

@@ -0,0 +1,51 @@
+# MkDocs
+site/
+.mkdocs.yml.bak
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+venv/
+ENV/
+env/
+.venv
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Node modules
+node_modules/
+npm-debug.log
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# Build output
+*.tsbuildinfo

docs/BUILD.md

@@ -0,0 +1,162 @@
+# Building Documentation Locally
+
+This guide explains how to build and serve the MkDocs documentation locally for development and testing.
+
+## Prerequisites
+
+- Python 3.8 or higher
+- pip package manager
+
+## Installation
+
+### 1. Create a Virtual Environment (Recommended)
+
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+```
+
+### 2. Install Dependencies
+
+```bash
+pip install -r requirements-docs.txt
+```
+
+Or install manually:
+
+```bash
+pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized pymdown-extensions
+```
+
+## Building Documentation
+
+### Serve Locally (Development)
+
+```bash
+mkdocs serve
+```
+
+This will:
+- Build the documentation
+- Start a local server at `http://localhost:8000`
+- Watch for file changes and auto-reload
+
+### Build Static Site
+
+```bash
+mkdocs build
+```
+
+This will:
+- Generate static HTML files in the `site/` directory
+- Ready for deployment to GitHub Pages
+
+## Configuration
+
+The documentation is configured in `mkdocs.yml`. Key configurations:
+
+- **Site name**: Hacktoolkit HTK
+- **Theme**: Material for MkDocs
+- **Documentation root**: `docs/` directory
+- **Navigation**: Defined in `nav` section of mkdocs.yml
+
+## File Structure
+
+```
+docs/
+├── index.md              # Home page
+├── components/           # Component documentation
+│   ├── index.md
+│   └── dialogs/
+├── features/            # Feature documentation
+│   ├── index.md
+│   ├── appsettings/
+│   ├── theme/
+│   └── expo/
+├── utils/               # Utility documentation
+│   ├── index.md
+│   ├── string.md
+│   ├── enum.md
+│   └── ...
+├── storages/            # Storage documentation
+├── states/              # State management docs
+└── types/               # Type definitions docs
+```
+
+## Adding New Documentation
+
+1. Create a new `.md` file in the appropriate folder
+2. Add an entry to the `nav` section in `mkdocs.yml`
+3. Use the following front matter for consistency:
+
+```markdown
+# Page Title
+
+## Overview
+Brief description of the topic.
+
+## Usage
+Examples and how-tos.
+
+## API Reference
+Detailed function/component signatures.
+
+## Best Practices
+Recommended patterns.
+```
+
+## Deployment
+
+### Automatic (GitHub Actions)
+
+Documentation is automatically deployed to GitHub Pages when:
+- Changes are pushed to the `master` branch
+- Files in `docs/`, `mkdocs.yml`, or `**.md` are modified
+
+The workflow is defined in `.github/workflows/deploy-docs.yml`
+
+### Manual Deployment
+
+```bash
+mkdocs gh-deploy
+```
+
+This will:
+- Build the documentation
+- Push to the `gh-pages` branch
+- Deploy to GitHub Pages
+
+## Troubleshooting
+
+### Import Error: No module named 'mkdocs'
+
+```bash
+pip install -r requirements-docs.txt
+```
+
+### Port 8000 Already in Use
+
+```bash
+mkdocs serve -a localhost:8001
+```
+
+### Changes Not Reflecting
+
+- Stop the server (Ctrl+C)
+- Rebuild: `mkdocs serve`
+- Clear browser cache (Ctrl+Shift+Delete)
+
+## Documentation Standards
+
+- Use Markdown format (`.md`)
+- Follow the existing structure and naming conventions
+- Include code examples in appropriate language blocks
+- Use meaningful headers and sections
+- Keep documentation up-to-date with code changes
+
+## More Information
+
+- [MkDocs Documentation](https://www.mkdocs.org/)
+- [Material Theme Guide](https://squidfunk.github.io/mkdocs-material/)
+- [Markdown Reference](https://www.markdownguide.org/)
+