coulomb/markitect-main
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
markitect-main/docs/README.md

78 lines
3.1 KiB
Markdown
Raw Normal View History

feat: Complete Issue #13 - Cache Management CLI Commands ⭐ MAJOR MILESTONE Implemented comprehensive cache management interface following TDD8 methodology: **Cache Commands:** - cache-info: Display cache statistics (directory, file count, size) - cache-clean: Clear all cached files with user feedback - cache-invalidate <file>: Remove specific file cache **Architecture:** - Service layer design with CacheDirectoryService - Convention over configuration following Rails paradigm - XDG Base Directory compliance with fallback hierarchy **Performance Benefits:** - 60-85% faster document processing through AST caching - User-accessible cache monitoring and maintenance **Quality Assurance:** - 15/15 comprehensive tests passing (behavior-focused) - Complete documentation with user guides and technical architecture - Service layer separation following project patterns **TDD8 Cycle Complete:** ISSUE → TEST → RED → GREEN → REFACTOR → DOCUMENT → REFINE → PUBLISH 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-09-25 23:03:03 +02:00
# MarkiTect Documentation
Welcome to the MarkiTect documentation. This directory contains comprehensive documentation for developers, users, and contributors.
## Documentation Structure
### 📐 Architecture Documentation (`architecture/`)
Deep technical documentation about system design, performance, and implementation details.
docs: add comprehensive capabilities architecture documentation Created detailed documentation for capabilities concept and integration: - CAPABILITIES_ARCHITECTURE.md: Full guide on separation of concerns - CAPABILITIES_QUICK_REFERENCE.md: Quick reference for common tasks - Updated docs/README.md to reference new documentation Ensures future sessions respect capability boundaries and use separate Claude instances for capability development. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-16 00:15:57 +01:00
- **[Capabilities Architecture](architecture/CAPABILITIES_ARCHITECTURE.md)** - **Critical:** How capabilities work as independent git submodules and separation of concerns
feat: Complete Issue #13 - Cache Management CLI Commands ⭐ MAJOR MILESTONE Implemented comprehensive cache management interface following TDD8 methodology: **Cache Commands:** - cache-info: Display cache statistics (directory, file count, size) - cache-clean: Clear all cached files with user feedback - cache-invalidate <file>: Remove specific file cache **Architecture:** - Service layer design with CacheDirectoryService - Convention over configuration following Rails paradigm - XDG Base Directory compliance with fallback hierarchy **Performance Benefits:** - 60-85% faster document processing through AST caching - User-accessible cache monitoring and maintenance **Quality Assurance:** - 15/15 comprehensive tests passing (behavior-focused) - Complete documentation with user guides and technical architecture - Service layer separation following project patterns **TDD8 Cycle Complete:** ISSUE → TEST → RED → GREEN → REFACTOR → DOCUMENT → REFINE → PUBLISH 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-09-25 23:03:03 +02:00
- **[Caching System](architecture/caching-system.md)** - Why and how MarkiTect's AST caching delivers 60-85% performance improvements
docs: add comprehensive capabilities architecture documentation Created detailed documentation for capabilities concept and integration: - CAPABILITIES_ARCHITECTURE.md: Full guide on separation of concerns - CAPABILITIES_QUICK_REFERENCE.md: Quick reference for common tasks - Updated docs/README.md to reference new documentation Ensures future sessions respect capability boundaries and use separate Claude instances for capability development. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-16 00:15:57 +01:00
- *Coming soon: Database Schema, CLI Architecture*
feat: Complete Issue #13 - Cache Management CLI Commands ⭐ MAJOR MILESTONE Implemented comprehensive cache management interface following TDD8 methodology: **Cache Commands:** - cache-info: Display cache statistics (directory, file count, size) - cache-clean: Clear all cached files with user feedback - cache-invalidate <file>: Remove specific file cache **Architecture:** - Service layer design with CacheDirectoryService - Convention over configuration following Rails paradigm - XDG Base Directory compliance with fallback hierarchy **Performance Benefits:** - 60-85% faster document processing through AST caching - User-accessible cache monitoring and maintenance **Quality Assurance:** - 15/15 comprehensive tests passing (behavior-focused) - Complete documentation with user guides and technical architecture - Service layer separation following project patterns **TDD8 Cycle Complete:** ISSUE → TEST → RED → GREEN → REFACTOR → DOCUMENT → REFINE → PUBLISH 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-09-25 23:03:03 +02:00
### 👥 User Guides (`user-guides/`)
End-user documentation for working with MarkiTect CLI and features.
- *Coming soon: Getting Started, Command Reference, Best Practices*
### 🔧 Development Documentation (`development/`)
Documentation for contributors and developers extending MarkiTect.
- *Coming soon: Contributing Guide, Testing Strategy, Release Process*
## Quick Links
### For Users
- [Installation & Setup](../README.md#getting-started)
- [Command Reference](user-guides/command-reference.md) *(coming soon)*
- [Performance Guide](user-guides/performance-guide.md) *(coming soon)*
### For Developers
- [Architecture Overview](architecture/) - System design and component relationships
- [Development Setup](development/) - Local development environment
- [API Documentation](development/api-reference.md) *(coming soon)*
### Project Management
chore: cleanup of repository root
2025-10-03 02:38:06 +02:00
- [Project Status](../history/ProjectStatusDigest.md) - Current development status
- [Roadmap](../history/ROADMAP.md) - Strategic development plan
feat: implement todofile system and retire NEXT.md Replace NEXT.md approach with standardized Keep a Todofile V0.0.1 format for better task management and human-AI collaboration during coding sessions. ## Todofile System Setup: - **TODO.md**: Main todofile following Keep a Todofile V0.0.1 format - **TODOFILE_GUIDE.md**: Comprehensive system documentation and workflow - **Integration**: Fully integrated with existing kaizen-agentic framework - **Agent Support**: Uses agent-keepaTodofile for maintenance ## Content Migration: - Migrated strategic priorities from NEXT.md to TODO.md [Unreleased] section - Preserved session success criteria and development milestones - Organized tasks by impact type (To Add, To Fix, To Refactor) - Archived NEXT.md to history/NEXT_archived_20251025.md ## Documentation Updates: - README.md: Updated "Next Actions" → "Current Tasks" link - agent-project-management.md: Updated workflow to use TODO.md - docs/README.md: Updated project management references - Added comprehensive TODOFILE_GUIDE.md ## Benefits: - **Standardized Format**: Industry-standard Keep a Todofile format - **Better Organization**: Impact-based task categorization - **AI-Ready**: Designed for human-AI collaboration workflows - **Context Preservation**: Maintains coding flow across session interruptions - **Integration Ready**: Works with existing agent and capability systems Active tasks now in TODO.md [Unreleased] section focusing on strategic issue resolution and capability management validation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-25 02:48:45 +02:00
- [Current Tasks](../TODO.md) - Task management using Keep a Todofile format
feat: Complete Issue #13 - Cache Management CLI Commands ⭐ MAJOR MILESTONE Implemented comprehensive cache management interface following TDD8 methodology: **Cache Commands:** - cache-info: Display cache statistics (directory, file count, size) - cache-clean: Clear all cached files with user feedback - cache-invalidate <file>: Remove specific file cache **Architecture:** - Service layer design with CacheDirectoryService - Convention over configuration following Rails paradigm - XDG Base Directory compliance with fallback hierarchy **Performance Benefits:** - 60-85% faster document processing through AST caching - User-accessible cache monitoring and maintenance **Quality Assurance:** - 15/15 comprehensive tests passing (behavior-focused) - Complete documentation with user guides and technical architecture - Service layer separation following project patterns **TDD8 Cycle Complete:** ISSUE → TEST → RED → GREEN → REFACTOR → DOCUMENT → REFINE → PUBLISH 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-09-25 23:03:03 +02:00
## Key Concepts
### Core Architecture Principles
1. **Parse Once, Use Many Times** - AST caching for 60-85% performance improvement
2. **Convention Over Configuration** - Sensible defaults with minimal setup
3. **Schema-Driven Processing** - Structured markdown with validation
4. **Relational Metadata** - Database-powered document relationships
### Performance Philosophy
MarkiTect treats markdown documents as **structured, queryable data** rather than plain text. This approach enables:
- Lightning-fast document processing through intelligent caching
- Complex querying and relationship management
- Schema validation and consistency enforcement
- Scalable performance that grows with your content
## Contributing to Documentation
Documentation follows the same quality standards as code:
1. **Clear Structure** - Logical organization and navigation
2. **Practical Examples** - Real-world usage patterns
3. **Performance Context** - Why architectural decisions matter
4. **User-Focused** - Written for the intended audience
### Documentation Standards
- Use clear, concise language
- Include practical examples
- Explain the "why" behind design decisions
- Keep technical accuracy as the highest priority
- Update docs when changing functionality
---
*This documentation is maintained alongside the codebase. For the most current information, always refer to the latest version in the repository.*
Reference in a new issue Copy permalink