Condenses Documentation

This commit is contained in:
2026-03-29 02:55:42 -04:00
parent 323484a33a
commit 55fe839882
14 changed files with 363 additions and 2971 deletions

View File

@@ -1,45 +1,14 @@
# TurboVault Documentation
Complete documentation for TurboVault - Video Game Collection Tracker
## Quick Links
## 📖 Documentation
- [Quick Start](QUICK_START.md) - Get up and running
- [Development](DEVELOPMENT_GUIDE.md) - Local development
- [Deployment](DEPLOYMENT.md) - Kubernetes deployment
- [API Reference](API_DOCUMENTATION.md) - RESTful API
- [IGDB Integration](IGDB_INTEGRATION.md) - Automatic metadata
### Getting Started
- [Main README](../README.md) - Project overview
- ⭐ [Quick Start Guide](QUICK_START.md) - **Deploy in minutes!**
- [Demo Account](DEMO_ACCOUNT.md) - Try the demo
## Demo
### Deployment & Development
- [Deployment Guide](DEPLOYMENT.md) - Complete deployment reference
- [Development Guide](DEVELOPMENT_GUIDE.md) - Local development & contributing
- [CI Pipeline](CI_PIPELINE.md) - GitHub Actions & quality checks
- [Kubernetes README](../k8s/README.md) - Kubernetes deployment
### Features & Development
- [API Documentation](API_DOCUMENTATION.md) - RESTful API reference
- [IGDB Integration](IGDB_INTEGRATION.md) - Game metadata matching
- [Themes](THEMES.md) - Theme customization
- [Sorbet Type Checking](SORBET.md) - Gradual static types
### Configuration
- [GitHub Secrets Setup](../.github/SECRETS_SETUP.md) - Optional custom registry
- [What to Commit](../.github/WHAT_TO_COMMIT.md) - Safe for open source
---
## 🚀 Quick Navigation
**New to TurboVault?**
1. Read [Main README](../README.md)
2. Deploy with [Quick Start Guide](QUICK_START.md) ⭐
3. Or develop locally with [Development Guide](DEVELOPMENT_GUIDE.md)
**Looking for something specific?**
- Deploying to production → [DEPLOYMENT.md](DEPLOYMENT.md)
- Using the API → [API_DOCUMENTATION.md](API_DOCUMENTATION.md)
- Game metadata features → [IGDB_INTEGRATION.md](IGDB_INTEGRATION.md)
- Customizing themes → [THEMES.md](THEMES.md)
---
**Need help?** Check the [Main README](../README.md) or [open an issue](https://github.com/yourusername/turbovault/issues).
Email: `demo@turbovault.com`
Password: `password123`