📚 Documentation Map

Quick reference guide to navigate PGLife documentation.

🗺️ Documentation Navigation

┌─────────────────────────────────────────────────────────────┐
│                     PGLife Documentation                    │
└─────────────────────────────────────────────────────────────┘

📦 Root Level (Start Here)
├─ 📖 README.md ..................... Project overview & setup
├─ 🤝 CONTRIBUTING.md ............... How to contribute
├─ 🚢 DEPLOYMENT.md ................. Deploy to production
└─ 📋 CHANGELOG.md .................. Version history

📁 docs/ (Technical Documentation)
├─ 📇 README.md ..................... Documentation index
├─ 🔐 CODE_REVIEW_REPORT.md ......... Security audit report
├─ 💻 DEVELOPMENT.md ................ Command reference
├─ 📊 MONITORING_GUIDE.md ........... Production monitoring
├─ 🏗️  PROJECT_STRUCTURE.md ......... Codebase organization
└─ 🚨 RUNBOOK.md .................... Emergency procedures

📁 docs/guides/ (How-To Guides)
├─ 🧪 TESTING.md .................... Testing & CI/CD
└─ 🔍 DEEP_SCAN.md .................. Code quality tools

📁 docs/archive/ (Historical)
├─ 📈 DEEP_SCAN_COMPARISON.md ....... Tool comparison
└─ 🎨 UI_AUDIT_REPORT.md ............ UI/UX audit

📁 .github/ (GitHub Config)
├─ ⚙️  copilot-instructions.md ....... Copilot guidelines
└─ 📝 PULL_REQUEST_TEMPLATE.md ...... PR template

📁 tests/e2e/ (Testing)
└─ 🧪 README.md ..................... E2E test docs

🎯 Quick Access by Role

👨‍💻 New Developer

1. Start: README.md
2. Setup: CONTRIBUTING.md
3. Commands: docs/DEVELOPMENT.md
4. Structure: docs/PROJECT_STRUCTURE.md

🚀 DevOps/SRE

1. Deploy: DEPLOYMENT.md
2. Monitor: docs/MONITORING_GUIDE.md
3. Emergency: docs/RUNBOOK.md

🧪 QA Engineer

1. Testing: docs/guides/TESTING.md
2. E2E Tests: tests/e2e/README.md
3. Contributing: CONTRIBUTING.md

🔒 Security Team

1. Audit: docs/CODE_REVIEW_REPORT.md
2. Scanning: docs/guides/DEEP_SCAN.md

👔 Product/Management

1. Overview: README.md
2. Changelog: CHANGELOG.md

📖 Document Descriptions

Document	Size	Purpose
README.md	48KB	Complete project overview
CONTRIBUTING.md	10KB	Development guidelines
DEPLOYMENT.md	10KB	Production deployment
CHANGELOG.md	6KB	Version history
docs/CODE_REVIEW_REPORT.md	13KB	Security findings
docs/DEVELOPMENT.md	15KB	Command reference
docs/MONITORING_GUIDE.md	26KB	Monitoring setup
docs/PROJECT_STRUCTURE.md	10KB	Codebase structure
docs/RUNBOOK.md	9KB	Operations guide
docs/guides/TESTING.md	9KB	Testing strategy
docs/guides/DEEP_SCAN.md	16KB	Code quality
tests/e2e/README.md	20KB	E2E test docs

🔍 Finding Information

Common Questions

"How do I set up the project?" → README.md

"What commands are available?" → docs/DEVELOPMENT.md

"How do I contribute code?" → CONTRIBUTING.md

"How do I deploy to production?" → DEPLOYMENT.md

"How do I run tests?" → docs/guides/TESTING.md

"What was fixed in the security audit?" → docs/CODE_REVIEW_REPORT.md

"How do I monitor production?" → docs/MONITORING_GUIDE.md

"What do I do in an emergency?" → docs/RUNBOOK.md

📊 Documentation Stats

• Total Files: 17 essential docs (+ 2 archived + 2 in .github)
• Total Size: ~200KB
• Coverage: Complete (setup, development, testing, deployment, operations)
• Status: ✅ Production Ready
• Last Updated: 2026-03-30

🔄 Keeping Documentation Updated

When making changes:

1. Update the relevant documentation file
2. Update this map if structure changes
3. Update CHANGELOG.md for version changes
4. Update README.md for major features

---

Need help? Open an issue or start a discussion.