Summary
The docs/ directory contains four overlapping deployment documents:
DEPLOYMENT.md
DEPLOYMENT_GUIDE.md
DEPLOYMENT_PRODUCTION.md
PRODUCTION_DEPLOYMENT.md
This creates confusion about which guide is authoritative and leads to instructions getting out of sync.
Proposed Solution
- Audit all four files for unique content not present in the others
- Merge into a single
docs/DEPLOYMENT.md with sections:
- Local development (Docker Compose)
- Staging (Docker)
- Production (Kubernetes)
- Environment variables reference
- Rollback procedure
- Delete the three redundant files
- Update
docs/DOCUMENTATION_INDEX.md and readme.md to point to the new file
Acceptance Criteria
Summary
The
docs/directory contains four overlapping deployment documents:DEPLOYMENT.mdDEPLOYMENT_GUIDE.mdDEPLOYMENT_PRODUCTION.mdPRODUCTION_DEPLOYMENT.mdThis creates confusion about which guide is authoritative and leads to instructions getting out of sync.
Proposed Solution
docs/DEPLOYMENT.mdwith sections:docs/DOCUMENTATION_INDEX.mdandreadme.mdto point to the new fileAcceptance Criteria
docs/DEPLOYMENT.mdcovers all environmentsreadme.mdor other docs