Skip to content

Conversation

@NormB
Copy link
Owner

@NormB NormB commented Dec 30, 2025

Summary

  • Archive historical documents to docs/archive/ that are obsolete or point-in-time reports
  • Add cross-references between related documentation files
  • Update docs/README.md index to remove references to archived documents

Changes

Archived Documents

The following documents have been moved to docs/archive/ as they are historical records rather than current documentation:

Document Reason
IMPROVEMENTS_2025-11-19.md Point-in-time PR summary from November
NEW_TESTS_SUMMARY.md Historical test addition summary
PHASE_4_SUMMARY.md Phase completion report
TEST_VALIDATION_REPORT.md Point-in-time validation report

Improved Cross-References

Added related documentation links to guide users between complementary documents:

  • UPGRADE_GUIDE.mdMIGRATION_GUIDE.md
  • DISASTER_RECOVERY.mdROLLBACK_PROCEDURES.md
  • All guides now link to related troubleshooting documentation

Updated Index

  • Updated docs/README.md documentation coverage table
  • Removed references to archived documents
  • Added note about archive location for historical documents

Test plan

  • Verify archived documents are accessible in docs/archive/
  • Verify cross-reference links are valid
  • Verify docs/README.md renders correctly

- Archive historical documents to docs/archive/:
  - IMPROVEMENTS_2025-11-19.md (point-in-time PR summary)
  - NEW_TESTS_SUMMARY.md (historical test addition summary)
  - PHASE_4_SUMMARY.md (phase completion report)
  - TEST_VALIDATION_REPORT.md (point-in-time validation report)

- Add cross-references between related documents:
  - UPGRADE_GUIDE.md ↔ MIGRATION_GUIDE.md
  - DISASTER_RECOVERY.md ↔ ROLLBACK_PROCEDURES.md
  - All guides now link to related troubleshooting docs

- Update docs/README.md:
  - Remove references to archived documents
  - Update documentation coverage table
  - Add note about archive location

- Update document dates and version numbers
@NormB NormB merged commit 3d80ccf into main Dec 30, 2025
31 checks passed
@NormB NormB deleted the docs/cleanup-and-improvements branch December 30, 2025 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants