# Fraiseql-Wire Documentation Index
## Quick Navigation
**New to fraiseql-wire?**
→ Start with [README.md](README.md) and [QUICK_START.md](QUICK_START.md)
**Building with it?**
→ See [DEVELOPMENT.md](DEVELOPMENT.md) and [CONTRIBUTING.md](CONTRIBUTING.md)
**Running into issues?**
→ Check [TROUBLESHOOTING.md](TROUBLESHOOTING.md)
**Need performance insights?**
→ Read [PERFORMANCE_TUNING.md](PERFORMANCE_TUNING.md)
---
## Core Documentation
### Essential
- **[README.md](README.md)** – What fraiseql-wire is and why you'd use it
- **[QUICK_START.md](QUICK_START.md)** – Installation and basic examples
- **[PRD.md](PRD.md)** – Product requirements and design philosophy
### Development
- **[DEVELOPMENT.md](DEVELOPMENT.md)** – Local setup, build commands, architecture
- **[CONTRIBUTING.md](CONTRIBUTING.md)** – Contribution guidelines and workflows
- **[TESTING_GUIDE.md](TESTING_GUIDE.md)** – Unit, integration, and load tests
- **[CI_CD_GUIDE.md](CI_CD_GUIDE.md)** – GitHub Actions and release workflow
### Operational
- **[TROUBLESHOOTING.md](TROUBLESHOOTING.md)** – Error diagnosis and solutions
- **[SECURITY.md](SECURITY.md)** – Security considerations and best practices
- **[DOCKER_SETUP.md](DOCKER_SETUP.md)** – Docker development environment
---
## Advanced Topics
### Performance & Optimization
- **[PERFORMANCE_TUNING.md](PERFORMANCE_TUNING.md)** – Benchmarking and optimization strategies
- **[BENCHMARK_IMPROVEMENTS.md](BENCHMARK_IMPROVEMENTS.md)** – Performance optimization history
- **[PERFORMANCE_VALIDATION_RESULTS.md](PERFORMANCE_VALIDATION_RESULTS.md)** – Measured improvements
- **[METRICS.md](METRICS.md)** – Available metrics and monitoring
- **[METRICS_PERFORMANCE.md](METRICS_PERFORMANCE.md)** – Metrics collection performance
### Features
- **[TYPED_STREAMING_GUIDE.md](TYPED_STREAMING_GUIDE.md)** – Type-safe deserialization
- **[METRICS.md](METRICS.md)** – Metrics and tracing
### Project Info
- **[CHANGELOG.md](CHANGELOG.md)** – Release notes and version history
- **[ROADMAP.md](ROADMAP.md)** – Future plans and priorities
- **[SECURITY_AUDIT.md](SECURITY_AUDIT.md)** – Security audit results
---
## Archived Documentation
Historical phase documentation has been archived in **[.archive/phases/](.archive/phases/)**.
This includes:
- Complete Phase 7 (Foundation) documentation
- Complete Phase 8 (8-phase optimization journey) documentation
- Session notes and intermediate planning documents
→ See **[.archive/phases/README.md](.archive/phases/README.md)** for the full archive index.
---
## Document Quick Reference
| First time setup | QUICK_START.md | Get started in 5 minutes |
| Architecture | README.md + DEVELOPMENT.md | Understand design |
| Features | TYPED_STREAMING_GUIDE.md | Advanced features |
| Performance | PERFORMANCE_TUNING.md | Optimize queries |
| Errors | TROUBLESHOOTING.md | Debug issues |
| Contributing | CONTRIBUTING.md | Submit changes |
| Security | SECURITY.md | Safe practices |
| Testing | TESTING_GUIDE.md | Run test suite |
| Deployment | CI_CD_GUIDE.md | Release process |
---
## Version Information
**Current Version:** 0.1.0
**Status:** Stable
**MSRV:** Rust 1.75+
**API Stability:** Stable (unlikely breaking changes)
---
## Getting Help
1. **Documentation**: Read the relevant guide for your use case
2. **Examples**: See `examples/` directory for working code
3. **Tests**: Check `tests/` for usage patterns
4. **Issues**: Report bugs on GitHub
---
## For Maintainers
- **Development**: See DEVELOPMENT.md
- **Contributing**: See CONTRIBUTING.md
- **CI/CD**: See CI_CD_GUIDE.md
- **Release**: See CI_CD_GUIDE.md → Release Workflow
- **Security**: See SECURITY_AUDIT.md