docs: setup mkdocs documentation with module README symlinks

Set up local and deployable documentation using mkdocs with symlinked module READMEs. This eliminates duplication by pointing to the original module documentation sources.

## Problem
Documentation was not accessible locally or configured for deployment. Module READMEs existed but weren't integrated into a documentation system.

## Solution
Created mkdocs configuration that:
- Uses symlinks in `docs/` directory pointing to module README.md files
- Eliminates file duplication - single source of truth
- Supports both local development (mkdocs serve) and GitHub Pages deployment
- Auto-updates when module README files change

## Changes
- Updated README.md links from GitHub format (`./apps/`) to mkdocs format (`apps.md`)
- Updated .gitignore to allow tracking of `docs/` and `site/` directories
- Created `docs/` directory with symlinks to all 17 module README files
- Documentation now accessible at: http://127.0.0.1:8000/django-htk/ (locally)

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

Co-Authored-By: Claude <noreply@anthropic.com>

Author: YosefAshenafi

.gitignore

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

README.md

@@ -6,14 +6,14 @@ A comprehensive Django framework providing reusable apps, utilities, and third-p
 
 HTK includes:
 
-- **[Reusable Django Apps](./apps/)** - Pre-built apps for accounts, organizations, payments, messaging, and more
-- **[Third-Party Integrations](./lib/)** - Ready-to-use connectors for 45+ external services (Stripe, Google, AWS, Slack, etc.)
-- **[Utility Modules](./utils/)** - Common patterns for caching, text processing, APIs, and data handling
-- **[API Helpers](./api/)** - Tools for building REST APIs with DataTables support
-- **[Form Utilities](./forms/)** - Base form classes and validators
-- **[Decorators](./decorators/)** - Django and function decorators for common tasks
-- **[Models & Fields](./models/)** - Abstract models and custom Django fields
-- **[Middleware](./middleware/)** - Request/response processing utilities
+- **[Reusable Django Apps](apps.md)** - Pre-built apps for accounts, organizations, payments, messaging, and more
+- **[Third-Party Integrations](lib.md)** - Ready-to-use connectors for 45+ external services (Stripe, Google, AWS, Slack, etc.)
+- **[Utility Modules](utils.md)** - Common patterns for caching, text processing, APIs, and data handling
+- **[API Helpers](api.md)** - Tools for building REST APIs with DataTables support
+- **[Form Utilities](forms.md)** - Base form classes and validators
+- **[Decorators](decorators.md)** - Django and function decorators for common tasks
+- **[Models & Fields](models.md)** - Abstract models and custom Django fields
+- **[Middleware](middleware.md)** - Request/response processing utilities
 
 ## Quick Start
 
@@ -85,7 +85,7 @@ from htk.api.utils import json_response_form_error, get_object_or_json_error
 - Timezone handling
 
 ### Third-Party Services
-See [lib/README.md](./lib/) for details on 45+ integrations including:
+See [lib/README.md](lib.md) for details on 45+ integrations including:
 - Cloud: AWS S3, Google Cloud
 - Communication: Slack, Discord, Gmail, Twilio
 - Data: Airtable, Stripe, Shopify, Zuora
@@ -116,15 +116,15 @@ htk/
 
 For detailed information about each module, see:
 
-- **[Apps](./apps/README.md)** - Reusable Django application packages
-- **[Libraries](./lib/README.md)** - Third-party service integrations
-- **[Utilities](./utils/README.md)** - Helper functions and utilities
-- **[API](./api/README.md)** - REST API patterns and tools
-- **[Cache](./cache/README.md)** - Caching framework and patterns
-- **[Forms](./forms/README.md)** - Form utilities and base classes
-- **[Decorators](./decorators/README.md)** - Function and class decorators
-- **[Models](./models/README.md)** - Abstract models and custom fields
-- **[Validators](./validators/README.md)** - Validation utilities
+- **[Apps](apps.md)** - Reusable Django application packages
+- **[Libraries](lib.md)** - Third-party service integrations
+- **[Utilities](utils.md)** - Helper functions and utilities
+- **[API](api.md)** - REST API patterns and tools
+- **[Cache](cache.md)** - Caching framework and patterns
+- **[Forms](forms.md)** - Form utilities and base classes
+- **[Decorators](decorators.md)** - Function and class decorators
+- **[Models](models.md)** - Abstract models and custom fields
+- **[Validators](validators.md)** - Validation utilities
 
 ## Use Cases
 

docs/admin.md

@@ -0,0 +1 @@
+../admin/README.md

docs/admintools.md

@@ -0,0 +1 @@
+../admintools/README.md

docs/api.md

@@ -0,0 +1 @@
+../api/README.md

docs/apps.md

@@ -0,0 +1 @@
+../apps/README.md

docs/cache.md

@@ -0,0 +1 @@
+../cache/README.md

docs/constants.md

@@ -0,0 +1 @@
+../constants/README.md

docs/decorators.md

@@ -0,0 +1 @@
+../decorators/README.md

docs/extensions.md

@@ -0,0 +1 @@
+../extensions/README.md