|
| 1 | +# Documentation Structure |
| 2 | + |
| 3 | +This document explains the organization of SQL Parser Go documentation. |
| 4 | + |
| 5 | +## 📚 Documentation Files |
| 6 | + |
| 7 | +### Core Documentation |
| 8 | + |
| 9 | +1. **[README.md](README.md)** (310 lines) - **START HERE** |
| 10 | + - Project overview and key features |
| 11 | + - Quick start guide |
| 12 | + - Supported SQL features summary |
| 13 | + - Performance highlights |
| 14 | + - Development commands |
| 15 | + - Roadmap and contributing guidelines |
| 16 | + |
| 17 | +2. **[EXAMPLES.md](EXAMPLES.md)** - **Comprehensive Usage Examples** |
| 18 | + - Complete usage examples for all features |
| 19 | + - Multi-dialect examples (MySQL, PostgreSQL, SQL Server, SQLite, Oracle) |
| 20 | + - DML statements (INSERT, UPDATE, DELETE) |
| 21 | + - DDL statements (CREATE, DROP, ALTER, INDEX) |
| 22 | + - Advanced features (CTEs, Window Functions, Set Operations) |
| 23 | + - Subqueries and complex queries |
| 24 | + - Transaction control |
| 25 | + - Schema-aware parsing |
| 26 | + - Execution plan analysis |
| 27 | + - Command-line reference |
| 28 | + |
| 29 | +3. **[PERFORMANCE.md](PERFORMANCE.md)** - **Detailed Performance Benchmarks** |
| 30 | + - Multi-dialect performance comparison |
| 31 | + - Lexing, parsing, and analysis benchmarks |
| 32 | + - Advanced features performance |
| 33 | + - DDL/DML operations performance |
| 34 | + - Schema validation performance |
| 35 | + - Transaction performance |
| 36 | + - Memory usage analysis |
| 37 | + - Optimization strategies applied |
| 38 | + |
| 39 | +4. **[DIALECT_SUPPORT.md](DIALECT_SUPPORT.md)** - **Dialect-Specific Details** |
| 40 | + - MySQL syntax and features |
| 41 | + - PostgreSQL syntax and features |
| 42 | + - SQL Server syntax and features |
| 43 | + - SQLite syntax and features |
| 44 | + - Oracle syntax and features |
| 45 | + - Dialect comparison matrix |
| 46 | + |
| 47 | +5. **[CLAUDE.md](CLAUDE.md)** - **Developer Guide** |
| 48 | + - Project architecture and structure |
| 49 | + - Component documentation |
| 50 | + - Development workflow |
| 51 | + - Common development tasks |
| 52 | + - Performance tuning guide |
| 53 | + - Testing strategies |
| 54 | + - Code conventions |
| 55 | + |
| 56 | +## 🎯 Which Document to Read? |
| 57 | + |
| 58 | +### I want to... |
| 59 | + |
| 60 | +- **Get started quickly** → [README.md](README.md) |
| 61 | +- **See usage examples** → [EXAMPLES.md](EXAMPLES.md) |
| 62 | +- **Check performance** → [PERFORMANCE.md](PERFORMANCE.md) |
| 63 | +- **Learn about dialects** → [DIALECT_SUPPORT.md](DIALECT_SUPPORT.md) |
| 64 | +- **Contribute code** → [CLAUDE.md](CLAUDE.md) |
| 65 | + |
| 66 | +## 📊 Documentation Reorganization (December 2024) |
| 67 | + |
| 68 | +### Before |
| 69 | +- **README.md**: 974 lines (too long, hard to navigate) |
| 70 | +- Performance benchmarks scattered |
| 71 | +- Examples mixed with documentation |
| 72 | + |
| 73 | +### After |
| 74 | +- **README.md**: 310 lines (concise, focused) |
| 75 | +- **EXAMPLES.md**: Dedicated examples file |
| 76 | +- **PERFORMANCE.md**: Dedicated performance documentation |
| 77 | +- **DIALECT_SUPPORT.md**: Dialect-specific information |
| 78 | +- **CLAUDE.md**: Developer guide |
| 79 | + |
| 80 | +### Benefits |
| 81 | +✅ Easier to find information |
| 82 | +✅ Better organization |
| 83 | +✅ More maintainable |
| 84 | +✅ Clearer separation of concerns |
| 85 | +✅ Faster onboarding for new users |
| 86 | + |
| 87 | +## 🔗 Quick Links |
| 88 | + |
| 89 | +- [Main README](README.md) |
| 90 | +- [Usage Examples](EXAMPLES.md) |
| 91 | +- [Performance Benchmarks](PERFORMANCE.md) |
| 92 | +- [Dialect Support](DIALECT_SUPPORT.md) |
| 93 | +- [Developer Guide](CLAUDE.md) |
| 94 | +- [Example Queries](examples/queries/) |
| 95 | +- [Example Schemas](examples/schemas/) |
| 96 | + |
| 97 | +--- |
| 98 | + |
| 99 | +**Need help?** Start with [README.md](README.md) and follow the links to detailed documentation! |
0 commit comments