breedr/CLEANUP_NOTES.md

Documentation Cleanup Notes

Files to Delete (Outdated)

These documentation files are now outdated and should be deleted manually:

DATABASE_MIGRATIONS.md

• Reason: We no longer use migrations - clean init only
• Replacement: DATABASE.md has current schema documentation
• Action: Delete this file

DEPLOY_NOW.md

• Reason: Deployment info is outdated, superseded by README
• Replacement: README.md has up-to-date deployment instructions
• Action: Review and delete if redundant

FEATURE_IMPLEMENTATION.md

• Reason: Old implementation notes, likely stale
• Replacement: ROADMAP.md has current feature status
• Action: Review content, delete if redundant

FRONTEND_FIX_REQUIRED.md

• Reason: Specific bug fix notes, likely resolved
• Replacement: Issues are tracked in ROADMAP
• Action: Check if fixed, then delete

IMPLEMENTATION_PLAN.md

• Reason: Planning document, likely outdated
• Replacement: ROADMAP.md is the living document
• Action: Review and delete if redundant

SPRINT1_PEDIGREE_COMPLETE.md

• Reason: Sprint-specific notes, now historical
• Replacement: ROADMAP.md shows current progress
• Action: Archive or delete

migrate-now.sh

• Reason: Shell script for old migration system
• Replacement: Not needed - init.js handles everything
• Action: Delete this file

Files to Keep (Current)

DATABASE.md ✓

• Complete schema documentation
• Explains clean design (no migrations)
• Reference for developers

README.md ✓

• Main project documentation
• Installation and setup
• Current features
• Recently updated

ROADMAP.md ✓

• Development progress tracking
• Feature planning
• Version history
• Recently updated

INSTALL.md ✓

• Detailed installation instructions
• May need review for accuracy

QUICKSTART.md ✓

• Quick setup guide
• May need review for accuracy

Manual Cleanup Required

Gitea API doesn't support file deletion via MCP in some cases. To clean up:

# Pull the branch
git checkout docs/clean-schema-and-roadmap-update

# Delete outdated files
git rm DATABASE_MIGRATIONS.md
git rm DEPLOY_NOW.md
git rm FEATURE_IMPLEMENTATION.md
git rm FRONTEND_FIX_REQUIRED.md
git rm IMPLEMENTATION_PLAN.md
git rm SPRINT1_PEDIGREE_COMPLETE.md
git rm migrate-now.sh

# Commit and push
git commit -m "Clean: Remove outdated documentation files"
git push origin docs/clean-schema-and-roadmap-update

Post-Cleanup Review

After cleanup, review these files for accuracy:

1. INSTALL.md - Verify installation steps are current
2. QUICKSTART.md - Ensure quick start is up-to-date
3. docs/ folder - Review any documentation in docs/ directory

Summary

Keep:

• DATABASE.md (new, comprehensive)
• README.md (updated)
• ROADMAP.md (updated)
• INSTALL.md (needs review)
• QUICKSTART.md (needs review)

Delete:

• DATABASE_MIGRATIONS.md
• DEPLOY_NOW.md
• FEATURE_IMPLEMENTATION.md
• FRONTEND_FIX_REQUIRED.md
• IMPLEMENTATION_PLAN.md
• SPRINT1_PEDIGREE_COMPLETE.md
• migrate-now.sh