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:
29
docs/deployment/README.md
Normal file
29
docs/deployment/README.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# ShopDB Deployment Documentation
|
||||
|
||||
Complete deployment guides for development, Docker, and production environments.
|
||||
|
||||
## Quick Start
|
||||
|
||||
**Local development**: `LOCAL-DEV-SETUP.md`
|
||||
**Docker deployment**: `DOCKER-SETUP.md`
|
||||
**VM deployment**: `DEPLOY-TO-VM.md`
|
||||
|
||||
## Docker Deployment
|
||||
|
||||
- `DOCKER-SETUP.md` - Complete Docker setup and configuration
|
||||
- `DOCKER-PREBUILT-APPROACH.md` - Workaround for corporate proxy blocking npm in Docker
|
||||
- `PRODUCTION-READINESS.md` - Production deployment checklist
|
||||
|
||||
## Development
|
||||
|
||||
- `LOCAL-DEV-SETUP.md` - Setting up local development environment (Flask + Vite)
|
||||
|
||||
## VM Deployment
|
||||
|
||||
- `DEPLOY-TO-VM.md` - Deploying the C# endpoint agent to test VMs
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- `.claude/setup/` - MCP servers, VM configuration, and development tools
|
||||
- `.claude/maintenance/` - Operational checklists and maintenance procedures
|
||||
- `../shopdb-flask.wiki/ADR-004-deployment-topology.md` - Architecture decision record for deployment topology
|
||||
Reference in New Issue
Block a user