189 lines
6.4 KiB
Markdown
189 lines
6.4 KiB
Markdown
# Documentation Index
|
|
|
|
**Last Updated:** January 2025
|
|
**Purpose:** Complete guide to all documentation in the Moyos Wedding App repository
|
|
|
|
---
|
|
|
|
## Quick Start
|
|
|
|
**New to the project?** Start here:
|
|
1. [SSOT.md](SSOT.md) - Single Source of Truth (start here!)
|
|
2. [SSOT.md - Local Development Setup](SSOT.md#local-development-setup) - Get up and running
|
|
3. [SSOT.md - Environment Configuration](SSOT.md#environment-configuration) - Configure your environment
|
|
|
|
---
|
|
|
|
## Main Documentation
|
|
|
|
### [SSOT.md](SSOT.md) - Single Source of Truth
|
|
|
|
**The definitive documentation for the Moyos Wedding App.**
|
|
|
|
Contains:
|
|
- [Overview](SSOT.md#overview) - Project description, tech stack, features
|
|
- [Architecture](SSOT.md#architecture) - System architecture, directory structure, data flow
|
|
- [Local Development Setup](SSOT.md#local-development-setup) - Installation, setup, development commands
|
|
- [Environment Configuration](SSOT.md#environment-configuration) - All environment variables, security best practices
|
|
- [Database & Supabase](SSOT.md#database--supabase) - Database setup, Supabase integration, migrations
|
|
- [Deployment (Proxmox)](SSOT.md#deployment-proxmox) - Production deployment to Proxmox
|
|
- [Troubleshooting](SSOT.md#troubleshooting) - Common issues and solutions
|
|
- [Operations & Runbooks](SSOT.md#operations--runbooks) - Backup, monitoring, maintenance
|
|
|
|
**When to use:** Always start here. This is the single source of truth for all information.
|
|
|
|
---
|
|
|
|
## Supporting Documentation
|
|
|
|
### Operational Runbooks
|
|
|
|
#### [deployment-runbook.md](deployment-runbook.md)
|
|
**Detailed deployment procedures and runbooks.**
|
|
|
|
Contains:
|
|
- Pre-deployment checklist
|
|
- Step-by-step deployment process
|
|
- Post-deployment verification
|
|
- Rollback procedures
|
|
- Troubleshooting deployment issues
|
|
|
|
**When to use:** When deploying to production or staging.
|
|
|
|
#### [backup-procedures.md](backup-procedures.md)
|
|
**Backup and restore procedures.**
|
|
|
|
Contains:
|
|
- Backup strategy and frequency
|
|
- Automated backup setup
|
|
- Manual backup procedures
|
|
- Restore procedures
|
|
- Backup verification
|
|
|
|
**When to use:** When setting up backups, performing backups, or restoring from backups.
|
|
|
|
### Development Guidelines
|
|
|
|
#### [coding-standards.md](coding-standards.md)
|
|
**Code style guide and development standards.**
|
|
|
|
Contains:
|
|
- File and folder naming conventions
|
|
- Type definitions
|
|
- Component patterns
|
|
- API route structure
|
|
- Import organization
|
|
- Testing guidelines
|
|
|
|
**When to use:** When writing or reviewing code.
|
|
|
|
---
|
|
|
|
## Documentation Governance
|
|
|
|
### [DOCS_GOVERNANCE.md](DOCS_GOVERNANCE.md)
|
|
**Rules and guidelines for maintaining documentation.**
|
|
|
|
Contains:
|
|
- Documentation structure rules
|
|
- Naming conventions
|
|
- PR checklist for documentation
|
|
- How to update SSOT
|
|
- Versioning policy
|
|
|
|
**When to use:** When creating, updating, or reviewing documentation.
|
|
|
|
### [DOCS_MIGRATION_PLAN.md](DOCS_MIGRATION_PLAN.md)
|
|
**Complete migration plan for documentation consolidation.**
|
|
|
|
Contains:
|
|
- List of all markdown files
|
|
- Action for each file (KEEP/MERGE/DELETE/RENAME)
|
|
- Redirect map (old path → new path)
|
|
- Migration rationale
|
|
|
|
**When to use:** Reference for understanding documentation structure changes.
|
|
|
|
---
|
|
|
|
## Where to Find What
|
|
|
|
### Setup & Installation
|
|
- **Local Development:** [SSOT.md - Local Development Setup](SSOT.md#local-development-setup)
|
|
- **Environment Variables:** [SSOT.md - Environment Configuration](SSOT.md#environment-configuration)
|
|
- **Database Setup:** [SSOT.md - Database & Supabase](SSOT.md#database--supabase)
|
|
|
|
### Deployment
|
|
- **Quick Start:** [SSOT.md - Deployment (Proxmox)](SSOT.md#deployment-proxmox)
|
|
- **Detailed Procedures:** [deployment-runbook.md](deployment-runbook.md)
|
|
- **Backup Setup:** [backup-procedures.md](backup-procedures.md)
|
|
|
|
### Development
|
|
- **Code Standards:** [coding-standards.md](coding-standards.md)
|
|
- **Architecture:** [SSOT.md - Architecture](SSOT.md#architecture)
|
|
- **API Documentation:** [SSOT.md - Architecture](SSOT.md#architecture) (see data flow section)
|
|
|
|
### Troubleshooting
|
|
- **Common Issues:** [SSOT.md - Troubleshooting](SSOT.md#troubleshooting)
|
|
- **Deployment Issues:** [deployment-runbook.md](deployment-runbook.md) (troubleshooting section)
|
|
|
|
### Operations
|
|
- **Backups:** [backup-procedures.md](backup-procedures.md)
|
|
- **Monitoring:** [SSOT.md - Operations & Runbooks](SSOT.md#operations--runbooks)
|
|
- **Maintenance:** [SSOT.md - Operations & Runbooks](SSOT.md#operations--runbooks)
|
|
|
|
---
|
|
|
|
## Documentation Structure
|
|
|
|
```
|
|
docs/
|
|
├── SSOT.md # Single Source of Truth (START HERE)
|
|
├── DOCS_INDEX.md # This file - documentation index
|
|
├── DOCS_GOVERNANCE.md # Documentation governance rules
|
|
├── DOCS_MIGRATION_PLAN.md # Migration plan and file actions
|
|
├── deployment-runbook.md # Detailed deployment procedures
|
|
├── backup-procedures.md # Backup and restore procedures
|
|
└── coding-standards.md # Development guidelines
|
|
```
|
|
|
|
---
|
|
|
|
## Quick Reference
|
|
|
|
| What You Need | Where to Find It |
|
|
|---------------|------------------|
|
|
| **Project overview** | [SSOT.md - Overview](SSOT.md#overview) |
|
|
| **Local setup** | [SSOT.md - Local Development Setup](SSOT.md#local-development-setup) |
|
|
| **Environment variables** | [SSOT.md - Environment Configuration](SSOT.md#environment-configuration) |
|
|
| **Database setup** | [SSOT.md - Database & Supabase](SSOT.md#database--supabase) |
|
|
| **Deploy to production** | [SSOT.md - Deployment (Proxmox)](SSOT.md#deployment-proxmox) |
|
|
| **Deployment details** | [deployment-runbook.md](deployment-runbook.md) |
|
|
| **Backup procedures** | [backup-procedures.md](backup-procedures.md) |
|
|
| **Troubleshooting** | [SSOT.md - Troubleshooting](SSOT.md#troubleshooting) |
|
|
| **Code standards** | [coding-standards.md](coding-standards.md) |
|
|
| **Architecture** | [SSOT.md - Architecture](SSOT.md#architecture) |
|
|
|
|
---
|
|
|
|
## Contributing to Documentation
|
|
|
|
1. **Read [DOCS_GOVERNANCE.md](DOCS_GOVERNANCE.md)** - Understand the rules
|
|
2. **Update SSOT.md** - Add/update information in the single source of truth
|
|
3. **Update this index** - If adding new supporting docs, update this file
|
|
4. **Link from SSOT** - Ensure new content is linked from SSOT.md
|
|
5. **Run validation** - Run `./scripts/check-docs.sh` before committing
|
|
|
|
---
|
|
|
|
## Questions?
|
|
|
|
- **Can't find what you need?** Check [SSOT.md](SSOT.md) first
|
|
- **Documentation outdated?** Update [SSOT.md](SSOT.md) and create a PR
|
|
- **New documentation needed?** Read [DOCS_GOVERNANCE.md](DOCS_GOVERNANCE.md) first
|
|
|
|
---
|
|
|
|
**Last Updated:** January 2025
|
|
**Maintained By:** Development Team
|