denverm/moyosapp_beta.0.0.3.3_beta
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
moyosapp_beta.0.0.3.3_beta/docs/DOCS_INDEX.md
moyoza 1b0063955a first commit beta.0.0.3.3
2026-01-16 19:04:48 +02:00

6.4 KiB
Raw Permalink Blame History

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 - Single Source of Truth (start here!)
  2. SSOT.md - Local Development Setup - Get up and running
  3. SSOT.md - Environment Configuration - Configure your environment

Main Documentation

SSOT.md - Single Source of Truth

The definitive documentation for the Moyos Wedding App.

Contains:

When to use: Always start here. This is the single source of truth for all information.

Supporting Documentation

Operational Runbooks

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 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

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

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

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

Deployment

Development

Troubleshooting

Operations

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
Local setup SSOT.md - Local Development Setup
Environment variables SSOT.md - Environment Configuration
Database setup SSOT.md - Database & Supabase
Deploy to production SSOT.md - Deployment (Proxmox)
Deployment details deployment-runbook.md
Backup procedures backup-procedures.md
Troubleshooting SSOT.md - Troubleshooting
Code standards coding-standards.md
Architecture SSOT.md - Architecture

Contributing to Documentation

  1. Read 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?

Last Updated: January 2025
Maintained By: Development Team