mirror of
https://codeberg.org/PostERG/xamxam.git
synced 2026-05-06 11:09:18 +02:00
3cd96ed28a
- Consolidate 36 markdown files → 14 (plus TODO.md) - Merge overlapping docs into authoritative files: - database.md (from DATABASE_SPECIFICATION + QUICK_SCHEMA_REFERENCE + DATABASE_CONFIG + SETUP) - deployment.md (from SERVER_SETUP + COMPLETE_DEPLOYMENT_GUIDE + DEPLOYMENT_STEPS) - security.md (from SECURITY_ANALYSIS + TODO.SECURITY) - development.md (from DEVELOPMENT_GUIDE + LIVE_RELOAD_SETUP + TEST_CENTRALIZATION) - migration-history.md (from 11 past migration docs) - Standardise all filenames to lowercase - Remove non-doc files (Context.md research notes, chat export) - Remove superseded docs (SECURITY.md pre-SQLite, SECURITY_IMPLEMENTATION, README_SECURE_SEARCH) - Fix stale cross-references
3.1 KiB
3.1 KiB
TODO — Docs Deduplication & Standardization
Analysis
- 36 markdown files, many heavily duplicated across topic clusters
- Filenames inconsistent (SCREAMING_CASE, Title-Case, lowercase)
- Historical migration docs scattered across 10+ files
- Security docs split across 5 files with overlapping content
- Database docs duplicated across 4 files (~72KB → ~20KB)
Plan
Consolidate into authoritative docs
database.md— merge DATABASE_SPECIFICATION + QUICK_SCHEMA_REFERENCE + DATABASE_CONFIG + SETUP.md (schema & config sections)deployment.md— merge SERVER_SETUP + COMPLETE_DEPLOYMENT_GUIDE + DEPLOYMENT_STEPSsecurity.md— merge SECURITY_ANALYSIS + TODO.SECURITYdevelopment.md— merge DEVELOPMENT_GUIDE + LIVE_RELOAD_SETUP + TEST_CENTRALIZATIONmigration-history.md— consolidate all past migration docs into one reference
Rename to lowercase kebab-case (standard convention)
- SEARCH_FEATURE.md → search.md
- IMPORT.md → import.md
- ORM_ASSESSMENT.md → orm-assessment.md
- REFACTORING_RECOMMENDATIONS.md → refactoring.md
- CSS_CLEANUP.md → css.md
- posterg_fiche-technique.md → spec-sheet.md
- TESTING_BEST_PRACTICES.md → testing.md
- ANALYSIS_PHP_VS_FLASK.md → php-vs-flask.md
Remove (superseded / not docs)
- Context.md (58KB research notes)
- chat-export-2026-04-02.md (chat log)
- SECURITY.md (pre-SQLite, superseded by security.md)
- SECURITY_IMPLEMENTATION.md (search security → covered by search.md + security.md)
- README_SECURE_SEARCH.md (duplicate of SECURITY_IMPLEMENTATION)
- SETUP.md (35KB, 90% duplicated → merged into database.md)
- DATABASE_CONFIG.md (merged into database.md)
- DATABASE_SPECIFICATION.md (merged into database.md)
- QUICK_SCHEMA_REFERENCE.md (merged into database.md)
- SERVER_SETUP.md (merged into deployment.md)
- COMPLETE_DEPLOYMENT_GUIDE.md (merged into deployment.md)
- DEPLOYMENT_STEPS.md (merged into deployment.md)
- DEVELOPMENT_GUIDE.md (merged into development.md)
- LIVE_RELOAD_SETUP.md (merged into development.md)
- TEST_CENTRALIZATION.md (merged into development.md)
- SECURITY_ANALYSIS.md (merged into security.md)
- TODO.SECURITY.md (merged into security.md)
- MIGRATION.md (merged into migration-history.md)
- MIGRATION_GUIDE.md (merged into migration-history.md)
- MIGRATION_CHECKLIST.md (merged into migration-history.md)
- MIGRATION_COMPLETE.md (merged into migration-history.md)
- DEPLOYMENT_MIGRATION.md (merged into migration-history.md)
- RESTRUCTURE_PLAN.md (merged into migration-history.md)
- DIRECTORY_STRUCTURE.md (merged into migration-history.md)
- SIMPLIFICATION.md (merged into migration-history.md)
- REPOSITORY_STRUCTURE_ANALYSIS.md (merged into migration-history.md)
- Analysis.md (merged into migration-history.md)
- assessments.md (merged into migration-history.md)
Final verification
- Cross-references updated (search.md self-reference fixed)
- No unique content lost (all information preserved in consolidated files)
- jj commit