PGLife Documentation

Welcome to the PGLife documentation hub. This directory contains all technical documentation, guides, and references for the project.

📚 Documentation Index

Getting Started

• Main README - Project overview and quick start
• Contributing Guide - How to contribute to the project
• Changelog - Version history and release notes

Deployment & Operations

• Deployment Guide - Production deployment instructions
• Monitoring Guide - Production monitoring setup
• Runbook - Emergency procedures and troubleshooting

Development Guides

• Development Reference - Command reference and workflows
• Project Structure - Codebase organization
• Testing Guide - Testing strategy and CI/CD
• Deep Scan Guide - Code quality and security scanning

Technical References

• Code Review Report - Security audit findings
• E2E Tests - End-to-end test documentation

---

🗂️ Directory Structure

docs/
├── guides/                         # Development guides
│   ├── TESTING.md                  # Testing strategy & CI/CD
│   └── DEEP_SCAN.md                # Code quality scanning
│
├── archive/                        # Historical documents
│   ├── DEEP_SCAN_COMPARISON.md     # Scan tool comparison
│   └── UI_AUDIT_REPORT.md          # UI/UX audit report
│
├── CODE_REVIEW_REPORT.md           # Security audit report
├── DEVELOPMENT.md                  # Command reference
├── MONITORING_GUIDE.md             # Production monitoring
├── PROJECT_STRUCTURE.md            # Codebase structure
├── RUNBOOK.md                      # Operations runbook
└── README.md                       # This file

---

🚀 Quick Links by Role

For New Developers

1. Read Main README for project overview
2. Follow Contributing Guide for setup
3. Review Project Structure
4. Check Testing Guide before commits

For DevOps/SREs

1. Read Deployment Guide
2. Set up Monitoring
3. Keep Runbook handy for incidents
4. Review Deployment Checklist

For QA Engineers

1. Review Testing Guide
2. Run manual tests from test plan
3. Report issues following Contributing Guide

For Security Team

1. Review Code Review Report
2. Run Deep Scan before releases

---

📧 Need Help?

• General Questions: Open a Discussion
• Documentation Issues: Open an Issue with documentation label
• Urgent Issues: Check Runbook for emergency procedures

---

Last Updated: 2026-03-30
Maintainer: Development Team