proxysql/doc/README.md

# ProxySQL Documentation Guide

## Documentation Structure

ProxySQL documentation is organized into different tiers to help developers find the information they need:

### 🔬 AI-Generated Documentation (Exploration Guides)

The `ai-generated/` directory contains documentation created by AI assistants to help developers explore the codebase:

> **⚠️ Important Notice**: AI-generated documentation may contain inaccuracies and should be used as a starting point for exploration only. Always verify critical information against the actual source code.

**Available AI-generated guides:**
- **`ai-generated/DOCUMENTATION-INDEX.md`** - Comprehensive index of all documentation
- **`ai-generated/architecture/ARCHITECTURE-OVERVIEW.md`** - System architecture and design patterns
- **`ai-generated/architecture/PROJECT-LAYOUT.md`** - Directory structure and module organization
- **`ai-generated/architecture/VISUAL-GUIDE.md`** - Architecture diagrams and visual references
- **`ai-generated/architecture/TEST-PIPELINE.md`** - Testing framework and CI/CD workflows
- **`ai-generated/architecture/RELEASE-PIPELINE.md`** - Release process and packaging

**Status: NON-VERIFIED**
- **Last AI Update**: 2025-09-11
- **Maintainer**: Rene Cannao

### 📋 Human-Verified Documentation

Critical documentation that has been reviewed and verified by maintainers:

- **`README.md`** - Main project overview and quick start
- **`INSTALL.md`** - Installation instructions
- **`FAQ.md`** - Frequently asked questions

### 🔧 Internal Documentation

Detailed technical documentation for specific components:

- **`doc/internal/`** - In-depth technical guides
- **`doc/release_notes/`** - Release notes and changelogs

## Using AI-Generated Documentation

1. **Start Here**: Use AI-generated docs to understand the codebase structure
2. **Verify Information**: Always cross-reference with actual source code
3. **Report Issues**: Help improve accuracy by reporting discrepancies

## Contributing to Documentation

- **AI Documentation**: Contributions are welcome - please verify against source code
- **Verified Documentation**: Follow the existing review process
- **Framework**: See `AI-DOCUMENTATION-FRAMEWORK.md` for guidelines

---

> This approach provides the benefits of AI-generated assistance while being transparent about limitations and reducing verification overhead.