# Documentation
Welcome to the SQL LSP documentation! This directory contains comprehensive guides for using and developing SQL LSP.
## 📚 Documentation Index
### For Users
- **[Configuration Guide](configuration.md)** - How to configure schemas and dialects
- **[Editor Integration](editor-integration.md)** - Setup instructions for popular editors
- VS Code
- Neovim
- Vim
- Emacs
- Sublime Text
### For Developers
- **[Error Handling](error-handling.md)** - Error handling strategies and best practices
- **[Architecture](../ARCHITECTURE.md)** - System architecture and design
- **[Contributing](../CONTRIBUTING.md)** - How to contribute to the project
### Project Information
- **[README](../README.md)** - Project overview and quick start
- **[Changelog](../CHANGELOG.md)** - Version history and changes
- **[Improvements](../IMPROVEMENTS.md)** - Recent improvements and enhancements
- **[Gap Analysis](../GAP_ANALYSIS.md)** - Feature gaps and roadmap
## 🚀 Quick Links
### Getting Started
1. [Installation](#installation)
2. [Basic Configuration](configuration.md#basic-configuration)
3. [Editor Setup](editor-integration.md)
### Common Tasks
- [Configure Database Schema](configuration.md#schema-configuration)
- [Enable Debug Logging](configuration.md#troubleshooting)
- [Add Custom Dialect](../CONTRIBUTING.md#adding-a-new-sql-dialect)
## 📖 Documentation Structure
```
docs/
├── README.md # This file
├── configuration.md # Configuration guide
├── editor-integration.md # Editor setup
└── error-handling.md # Error handling guide
```
## 🔗 External Resources
- [Language Server Protocol Specification](https://microsoft.github.io/language-server-protocol/)
- [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) - Parser library
- [Rust LSP Implementation](https://github.com/rust-lang/rust-analyzer)
## 💡 Tips
- Start with the [Configuration Guide](configuration.md) for basic setup
- Check [Editor Integration](editor-integration.md) for editor-specific instructions
- See [ARCHITECTURE.md](../ARCHITECTURE.md) for understanding the codebase
## 🆘 Getting Help
- **Issues**: Found a bug? [Report it](https://github.com/your-org/lsp_sqls/issues)
- **Discussions**: Have questions? [Ask the community](https://github.com/your-org/lsp_sqls/discussions)
- **Contributing**: Want to help? See [CONTRIBUTING.md](../CONTRIBUTING.md)
## 📝 Documentation Conventions
- Code examples use `bash` for shell commands
- Configuration examples use `json` format
- Inline code uses \`backticks\`
- File paths use `monospace` formatting
---
**Last Updated**: 2026-01-04
**Version**: 0.1.0