Skip to content

v2.0.0: Breaking Documentation Restructure

Choose a tag to compare

@devops-adeel devops-adeel released this 28 Aug 21:20
· 62 commits to main since this release

⚠️ Breaking Change: Documentation paths have changed.

Migration Guide

Path Changes

  • docs/TROUBLESHOOTING.md → docs/how-to/troubleshoot-common-issues.md
  • docs/ARCHITECTURE.md → docs/archive/ARCHITECTURE.md
  • docs/CLAUDE-CODE-SETUP.md → docs/tutorials/01-installation.md
  • Security docs consolidated → docs/reference/security.md
  • API documentation → docs/reference/api.md

New Features

  • 🧠 Session Summary Capture: Automatically capture coding sessions with GTD integration
  • 📚 Diátaxis Documentation: Clear separation of tutorials, how-to guides, reference, and explanations
  • 🔍 Memory Philosophy: Deep dive into temporal memory concepts

Improvements

  • 62% documentation reduction (1,850 → 700 lines)
  • Consolidated 3 troubleshooting guides into 1
  • Unified security configuration reference
  • Step-by-step tutorials for new users

For Developers

Update any scripts or references pointing to old documentation paths. All documentation is now organized under:

  • docs/tutorials/ - Learning-oriented guides
  • docs/how-to/ - Task-oriented guides
  • docs/reference/ - Information-oriented guides
  • docs/explanation/ - Understanding-oriented guides
  • docs/archive/ - Historical documentation