aherman
/
proxysql
mirror of https://github.com/sysown/proxysql
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '3daaa5c592'
${ noResults }
proxysql/doc
History
Rene Cannao 3daaa5c592
feat: Implement RAG (Retrieval-Augmented Generation) subsystem 		1 month ago
..
ANOMALY_DETECTION fix: Migrate AI variables to GenAI module for proper architecture 1 month ago
LLM_Bridge docs: Remove Version History section from LLM Bridge README 1 month ago
MCP docs: Update MCP documentation to reflect current implementation 1 month ago
VECTOR_FEATURES Refactor: Simplify NL2SQL to use only generic providers 1 month ago
ai-generated Add AI disclaimer to ENHANCEMENT-OPPORTUNITIES.md 3 months ago
internal Added detailed documentation 11 months ago
proxysql_cluster Added ProxySQL Cluster internal working documentation and flowchart 3 years ago
release_notes Updated release note 8 years ago
vector-search-test Add vector search testing framework with modular scripts 2 months ago
AI-DOCUMENTATION-FRAMEWORK.md Restructure AI-generated documentation with verification framework 3 months ago
GENAI.md Add comprehensive GenAI module documentation 1 month ago
README.md Restructure AI-generated documentation with verification framework 3 months ago
SQLITE-REMBED-TEST-README.md Fix sqlite-rembed demonstration scripts and add environment variable support 2 months ago
SQLite3-Server.md Integrate sqlite-rembed for text embedding generation 2 months ago
TAP_TESTS_GUIDE.md docs: Add TAP test writing guide for ProxySQL. 3 months ago
Two_Phase_Discovery_Implementation.md Fix two-phase discovery documentation and scripts 1 month ago
coredump_filters_documentation.md Document coredump_filters feature (issue #5213) 2 months ago
killed_client_connections_documentation.md Add comprehensive documentation for "Closing killed client connection" warnings 2 months ago
multi_agent_database_discovery.md Add multi-agent database discovery system 1 month ago
posts-embeddings-setup.md Add vec0 KNN LIMIT constraint documentation for Posts embeddings 2 months ago
query_rules_groups_documentation.md Add documentation for query rules capture groups and backreferences 2 months ago
rag-documentation.md feat: Implement RAG (Retrieval-Augmented Generation) subsystem 1 month ago
rag-examples.md feat: Implement RAG (Retrieval-Augmented Generation) subsystem 1 month ago
sqlite-rembed-demo.sh Fix sqlite-rembed demonstration scripts and add environment variable support 2 months ago
sqlite-rembed-examples.sh Fix sqlite-rembed demonstration scripts and add environment variable support 2 months ago
sqlite-rembed-examples.sql Add comprehensive sqlite-rembed examples and documentation 2 months ago
sqlite-rembed-integration.md Update sqlite-rembed integration documentation for tar.gz packaging 2 months ago
sqlite-rembed-test.sh Fix sqlite-rembed demonstration scripts and add environment variable support 2 months ago

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.