Enhanced Knowledge Graph Memory Server

# Documentation Inventory & Organization This document provides a complete inventory of the codebase documentation structure following GitHub best practices. ## Repository Structure ``` memory-mcp/ ├── .github/ # GitHub-specific files │ ├── CODE_REVIEW.md # Code review guidelines │ ├── FILE_SIZE_POLICY.md # File size policy │ ├── pull_request_template.md # PR template │ └── workflows/ # GitHub Actions workflows │ ├── docs/ # Documentation directory │ ├── README.md # Documentation index │ ├── API.md # Complete API reference │ ├── ARCHITECTURE.md # System architecture │ ├── WORKFLOW.md # Development workflow │ │ │ ├── guides/ # User guides │ │ ├── ARCHIVING.md # Archiving guide │ │ ├── COMPRESSION.md # Compression guide │ │ ├── HIERARCHY.md # Hierarchy guide │ │ ├── MIGRATION.md # Migration guide │ │ └── QUERY_LANGUAGE.md # Query language reference │ │ │ ├── development/ # Development documentation │ │ ├── IMPLEMENTATION_PLAN.md │ │ ├── IMPLEMENTATION_TASKS.md │ │ ├── IMPROVEMENT_PLAN.md │ │ └── REFACTORING_PLAN.md │ │ │ └── reports/ # Project reports │ ├── IMPROVEMENTS_SUMMARY.md │ ├── REFACTORING_SUMMARY.md │ ├── SPRINT_PROGRESS.md │ ├── SPRINT_SUMMARY.md │ └── TASK_SUMMARY.md │ ├── src/ # Source code │ └── memory/ │ ├── core/ # Core modules │ ├── features/ # Feature modules │ ├── search/ # Search modules │ ├── server/ # Server modules │ ├── types/ # Type definitions │ └── utils/ # Utility functions │ ├── scripts/ # Build and utility scripts │ ├── .vscode/ # VS Code settings │ ├── README.md # Main project README ├── LICENSE # MIT License ├── CHANGELOG.md # Version history ├── CONTRIBUTING.md # Contribution guidelines ├── CODE_OF_CONDUCT.md # Code of conduct ├── SECURITY.md # Security policy └── package.json # Package configuration ``` ## Documentation Organization ### Root Level (GitHub Standard Files) Following GitHub best practices, these files remain in the root directory: | File | Purpose | |------|---------| | README.md | Main project documentation and getting started guide | | LICENSE | MIT License text | | CHANGELOG.md | Version history and release notes | | CONTRIBUTING.md | Contribution guidelines | | CODE_OF_CONDUCT.md | Community code of conduct | | SECURITY.md | Security policy and vulnerability reporting | ### .github/ Directory GitHub-specific files and templates: | File | Purpose | |------|---------| | CODE_REVIEW.md | Code review guidelines for contributors | | FILE_SIZE_POLICY.md | Repository file size policy | | pull_request_template.md | Pull request template | | workflows/ | GitHub Actions CI/CD workflows | ### docs/ Directory All technical documentation organized by category: #### Core Documentation | File | Purpose | |------|---------| | README.md | Documentation index and navigation | | API.md | Complete API reference for 45+ tools | | ARCHITECTURE.md | Technical architecture and system design | | WORKFLOW.md | Development workflow and procedures | #### User Guides (docs/guides/) | File | Purpose | |------|---------| | ARCHIVING.md | Memory archiving guide | | COMPRESSION.md | Duplicate detection and compression | | HIERARCHY.md | Hierarchical organization guide | | MIGRATION.md | Version migration guide | | QUERY_LANGUAGE.md | Boolean query language reference | #### Development Documentation (docs/development/) | File | Purpose | |------|---------| | IMPLEMENTATION_PLAN.md | Overall implementation roadmap | | IMPLEMENTATION_TASKS.md | Detailed task breakdown | | IMPROVEMENT_PLAN.md | Enhancement proposals | | REFACTORING_PLAN.md | Code refactoring strategy | #### Project Reports (docs/reports/) | File | Purpose | |------|---------| | SPRINT_PROGRESS.md | Detailed sprint progress tracking | | SPRINT_SUMMARY.md | High-level sprint outcomes | | REFACTORING_SUMMARY.md | Architecture refactoring results | | IMPROVEMENTS_SUMMARY.md | Feature improvements summary | | TASK_SUMMARY.md | Completed tasks overview | ## Benefits of This Organization ### 1. GitHub Best Practices - Standard files (README, LICENSE, etc.) in root for GitHub discovery - .github/ for GitHub-specific features - docs/ for comprehensive documentation ### 2. Improved Navigation - Clear categorization (guides vs development vs reports) - Documentation index (docs/README.md) for easy discovery - Logical grouping by audience (users vs contributors) ### 3. Maintainability - Easier to find and update related documents - Reduces root directory clutter - Scalable structure for future documentation ### 4. Developer Experience - Quick access to relevant documentation - Clear separation of concerns - Better IDE/editor navigation ## Migration Notes All documentation has been moved using `git mv` to preserve history. The main README.md has been updated with links to the new documentation structure. ### Changes Made - Moved 16 markdown files from root to organized subdirectories - Created docs/README.md as documentation index - Updated main README.md with new documentation links - Preserved all git history through proper use of `git mv` --- Generated: 2025-11-26 Repository: https://github.com/danielsimonjr/memory-mcp