Files
motovaultpro/docs/redesign/PHASE-09-DOCUMENTATION.md
Eric Gullickson 046c66fc7d Redesign
2025-11-01 21:27:42 -05:00

3.7 KiB

Phase 9: Documentation Updates

Agent Assignment

Primary Agent: docs-agent Duration: 30-40 minutes

Prerequisites

  • None (FIRST WAVE - can start immediately)

Objectives

  1. Update all documentation for 6-container architecture
  2. Remove multi-tenant documentation
  3. Update container names throughout
  4. Update Makefile commands
  5. Update AI context files

Step-by-Step Instructions

Step 1: Update README.md

# Change from:
Modular monolith application with independent platform microservices.

# To:
Simplified 6-container architecture with integrated platform service.

## Quick Start (containers)
# Update all commands with new names:
make setup    # Uses mvp-* containers
make start    # Starts 6 services

Step 2: Update CLAUDE.md

Remove multi-tenant sections:

# REMOVE sections about:
- Multi-tenant architecture
- Tenant-specific database URLs
- Platform service independence (simplify to integrated service)

# UPDATE:
- Container names (admin-* → mvp-*)
- Architecture description (14 → 6 containers)

Step 3: Update AI-INDEX.md

# Update architecture line:
- Architecture: Simplified 6-container stack (was: Hybrid platform)

# Remove:
- Platform service development sections
- Tenant management guidance

Step 4: Update .ai/context.json

{
  "architecture": "simplified-6-container",
  "critical_requirements": {
    "mobile_desktop_development": true,
    "docker_first": true,
    "multi_tenant": false  // CHANGED
  },
  "services": {
    "mvp-traefik": "...",
    "mvp-frontend": "...",
    "mvp-backend": "...",
    "mvp-postgres": "...",
    "mvp-redis": "...",
    "mvp-platform": "..."
  }
}

Step 5: Update Makefile

Replace all container name references:

# Find and replace:
sed -i.bak 's/admin-backend/mvp-backend/g' Makefile
sed -i.bak 's/admin-frontend/mvp-frontend/g' Makefile
sed -i.bak 's/admin-postgres/mvp-postgres/g' Makefile
sed -i.bak 's/admin-redis/mvp-redis/g' Makefile

# Update help text:
echo "MotoVaultPro - Simplified 6-Container Architecture"

Step 6: Update docs/PLATFORM-SERVICES.md

# Simplify to document only mvp-platform service
# Remove:
- mvp-platform-tenants documentation
- mvp-platform-landing documentation
- ETL pipeline documentation

# Update:
- Service now uses mvp-postgres and mvp-redis
- No separate database instances

Step 7: Update docs/TESTING.md

# Update all container names in test commands:
make shell-backend  # Now uses mvp-backend
docker compose exec mvp-backend npm test

# Remove:
- Platform service test setup
- Tenant context in integration tests

Step 8: Update Feature READMEs

# Update each feature README:
for feature in vehicles fuel-logs maintenance stations documents; do
  sed -i.bak 's/admin-backend/mvp-backend/g' \
    backend/src/features/$feature/README.md
done

Step 9: Verify No Old References

grep -r "admin-backend\|admin-frontend\|admin-postgres" \
  README.md CLAUDE.md docs/ Makefile
# Expected: 0 results

grep -r "14 containers\|fourteen containers" docs/
# Expected: 0 results

Validation Criteria

  • README.md describes 6-container architecture
  • CLAUDE.md has no multi-tenant guidance
  • AI-INDEX.md updated
  • .ai/context.json updated
  • Makefile uses mvp-* names
  • docs/PLATFORM-SERVICES.md simplified
  • docs/TESTING.md updated
  • Feature READMEs updated
  • No old container name references

Validation Command:

grep -r "admin-backend" docs/ README.md CLAUDE.md Makefile | wc -l
# Expected: 0

Update EXECUTION-STATE.json

{
  "phases": {"9": {"status": "completed", "validation_passed": true}},
  "waves": {"1": {"status": "completed"}}
}