Reorganize repository structure and clean up documentation

Clean up and organize the flask-shopdb repository for better
maintainability and discoverability:

## Changes

- Update .gitignore for build artifacts (publish/, data/, 122M total)
- Reorganize .claude/ into 6 subdirectories with README navigation
- Consolidate overlapping MCP setup guides into MCP-QUICK-START.md
- Move deployment docs from root to docs/deployment/
- Archive dated status reports to .claude/archived/
- Delete temporary files (logs, backups, empty reports, ~50K)

## New Structure

.claude/ organized into:
- setup/ - MCP, VM, Hyper-V, GitHub setup guides + scripts (17 files)
- plans/ - Feature plans and protocols (5 files)
- maintenance/ - Deployment checklists and reports (4 files)
- archived/ - Historical documentation (9 files)
- skills/ - Claude Code automation (5 files)
- workflows/ - Security audit workflow (1 file)

docs/deployment/ created with 6 deployment guides:
- LOCAL-DEV-SETUP.md, DOCKER-SETUP.md, DOCKER-PREBUILT-APPROACH.md
- PRODUCTION-READINESS.md, DEPLOY-TO-VM.md, README.md

Root directory cleaned to essential docs only:
- CLAUDE.md, README.md, CONTRIBUTING.md, CHANGELOG.md

Benefits:
- Clear navigation via README.md in each subdirectory
- No duplicate/overlapping documentation
- Large artifacts properly gitignored (won't bloat repository)
- Historical context preserved in archived/

See .claude/CLEANUP-SUMMARY.md for complete details.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
Proudlock
2026-09-11 15:45:05 -04:00
parent 0b252db7d2
commit bd48814021
57 changed files with 11978 additions and 29 deletions

162
.claude/CLEANUP-SUMMARY.md Normal file
View File

@@ -0,0 +1,162 @@
# Repository Cleanup Summary
**Date:** 2026-09-11
**Branch:** wj
## Changes Made
### 1. Updated .gitignore
Added entries for directories that should never be committed:
- `data/` - Coordinator database (880K)
- `publish/` - Compiled agent binaries (104M)
- `asset-settings-handoff/` - Handoff artifacts
- `sbom.cdx.json` - Generated SBOM
- Deployment helper scripts: `deploy-agent-to-vm.cmd`, `start-dev.cmd`, `stop-dev.cmd`
### 2. Deleted Temporary Files
Removed:
- `asset-settings-handoff.zip`
- `flask.log`, `scan.log`
- `.dockerignore.backup`
- `scripts/backup/*.tmp`
- `report.md` (empty file)
**Space saved:** ~50K
### 3. Reorganized .claude/ Directory
**Before:** 31 markdown files in root, mixed purposes
**After:** 2 root files + organized subdirectories
New structure:
```
.claude/
├── INDEX.md # Project navigation (referenced in settings.json)
├── QUICK-REFERENCE.md # Commands and shortcuts
├── settings.json # Claude Code configuration
├── mcp-servers.json # MCP server configuration
│
├── setup/ (17 files) # Setup guides and scripts
│ ├── README.md
│ ├── MCP-QUICK-START.md # Consolidated MCP setup guide
│ ├── MCP-INTEGRATION-GUIDE.md
│ ├── MCP-COORDINATOR-*.md (2 files)
│ ├── GORTEX-MCP-SETUP.md
│ ├── GITHUB-MCP-SETUP.md
│ ├── INDEX-MCP-DOCS.md
│ ├── VM-*.md (2 files)
│ ├── HYPER-V-SETUP.md
│ └── Scripts (.ps1, .cmd)
│
├── plans/ (5 files) # Feature plans and protocols
│ ├── README.md
│ ├── SAML-FEATURE-PLAN.md
│ ├── security-improvements.md
│ ├── TOOL-ENGAGEMENT-PROTOCOL.md
│ └── AI-COLLABORATION.md
│
├── maintenance/ (4 files) # Operations and maintenance
│ ├── README.md
│ ├── MAINTENANCE-DEPLOYMENT-CHECKLIST.md
│ ├── DEV-STARTUP-CHECKLIST.md
│ └── MAINTENANCE-FOOTPRINT-REPORT.html
│
├── archived/ (7 files) # Historical documentation
│ ├── README.md
│ ├── FINAL-SUMMARY.md
│ ├── SETUP-COMPLETE-SUMMARY.md
│ ├── STATUS.md
│ ├── ACTIVATE-HYPERV-PERMS.md
│ ├── MCP-SETUP-GUIDE.md
│ ├── README-MCP-SETUP.md
│ ├── DOCKER-DEPLOYMENT-COMPLETE.md
│ └── DARKWING-FINDINGS.md
│
├── skills/ (5 files) # Claude Code automation skills
└── workflows/ (1 file) # Security audit workflow
```
**Consolidations:**
- MCP-SETUP-GUIDE.md + README-MCP-SETUP.md → MCP-QUICK-START.md
- HYPER-V-PERMISSIONS.md + ACTIVATE-HYPERV-PERMS.md → HYPER-V-SETUP.md (kept more detailed version)
### 4. Organized Root Documentation
Created `docs/deployment/` for deployment guides:
- `LOCAL-DEV-SETUP.md` (11K)
- `DOCKER-SETUP.md` (11K)
- `DOCKER-PREBUILT-APPROACH.md` (2.6K)
- `PRODUCTION-READINESS.md` (9.8K)
- `DEPLOY-TO-VM.md` (4.5K)
- `README.md` (new)
Archived dated status reports:
- `DOCKER-DEPLOYMENT-COMPLETE.md` (Sept 7 status)
- `DARKWING-FINDINGS.md` (Sept 7 security scan)
### 5. Updated Memory References
Updated `docker_prebuilt_approach.md` memory file to reflect new path:
- Old: `DOCKER-PREBUILT-APPROACH.md`
- New: `docs/deployment/DOCKER-PREBUILT-APPROACH.md`
## Disk Space Summary
| Directory | Size | Status | Notes |
|-----------|------|--------|-------|
| `.claude/` | 497K | Organized | Down from 441K (added READMEs, cleaned structure) |
| `publish/` | 104M | Gitignored | Build artifacts (can rebuild from source) |
| `data/` | 880K | Gitignored | Coordinator database (local state) |
| `frontend/dist/` | 17M | Gitignored | Frontend build output (already in .gitignore) |
| **Total ignored** | **~122M** | | Won't bloat repository |
## Benefits
1. **Clearer structure** - Documentation is discoverable via README files in each subdirectory
2. **No duplication** - Consolidated overlapping MCP setup guides
3. **Better gitignore** - Large build artifacts and local state won't accidentally commit
4. **Historical context preserved** - Dated docs archived, not deleted
5. **Memory updated** - File path references corrected
## Files Affected
**Modified:**
- `.gitignore` - Added entries for data/, publish/, asset-settings-handoff/, etc.
- `.claude/INDEX.md` - Added directory structure reference
- `.claude/setup/README.md` - Updated MCP documentation references
- `~/.claude/projects/.../memory/docker_prebuilt_approach.md` - Updated file path
**Deleted:**
- Temporary files (~50K)
- `report.md` (empty)
**Moved:**
- 17 files from `.claude/` → `.claude/setup/`
- 5 files from `.claude/` → `.claude/plans/`
- 4 files from `.claude/` → `.claude/maintenance/`
- 7 files from `.claude/` and root → `.claude/archived/`
- 5 files from root → `docs/deployment/`
**Created:**
- 6 README.md files (subdirectory navigation)
- `.claude/setup/MCP-QUICK-START.md` (consolidated guide)
## Next Steps (Optional)
If you want to reclaim disk space:
1. **Delete publish/ contents** - Can rebuild with build scripts (saves 104M)
2. **Delete data/coordinator.db** - Can recreate if needed (saves 880K)
3. **Further consolidate MCP docs** - Could merge more of the 6 MCP guides
## Verification
All changes staged for commit:
```bash
git status
git diff .gitignore
git diff .claude/INDEX.md
```
Repository is now cleaner, better organized, and documentation is discoverable.