tegwick
d592c5b8b3
Phase 4 Complete: Cleanup legacy files after successful migration Removed Files (29 total): - /markitect/static/js/ directory (entire directory deleted) * Core modules: debug-system.js, section-manager.js * Components: debug-panel.js, dom-renderer.js, document-controls.js * Configuration: config-loader.js * Main files: main.js, main-updated.js * Plugins: document-navigator-plugin.js * Widgets: UIWidget.js, Widget.js, DocumentNavigator.js * Test files: All test JS files and test HTML/MD files - /markitect/static/editor.js (unused legacy file) Preserved: - /markitect/static/css/ (still referenced in templates) Migration Impact: - ✅ Single source of truth: All JavaScript now in /capabilities/testdrive-jsui/js/ - ✅ No duplicate files in codebase - ✅ Clean separation: Capability is authoritative location - ✅ All tests still passing (84 automated tests) - ✅ Main app rendering verified (view & edit modes) Migration Status: - Phase 1: ✅ Complete (files copied to capability) - Phase 2: ⏭️ Skipped (comprehensive testing in Phase 1) - Phase 3: ✅ Complete (templates updated) - Phase 4: ✅ Complete (legacy files removed) 🎉 MIGRATION FULLY COMPLETE - All phases done 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
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.
- Capabilities Architecture - Critical: How capabilities work as independent git submodules and separation of concerns
- Caching System - Why and how MarkiTect's AST caching delivers 60-85% performance improvements
- Coming soon: Database Schema, CLI Architecture
👥 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
- Command Reference (coming soon)
- Performance Guide (coming soon)
For Developers
- Architecture Overview - System design and component relationships
- Development Setup - Local development environment
- API Documentation (coming soon)
Project Management
- Project Status - Current development status
- Roadmap - Strategic development plan
- Current Tasks - Task management using Keep a Todofile format
Key Concepts
Core Architecture Principles
- Parse Once, Use Many Times - AST caching for 60-85% performance improvement
- Convention Over Configuration - Sensible defaults with minimal setup
- Schema-Driven Processing - Structured markdown with validation
- 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:
- Clear Structure - Logical organization and navigation
- Practical Examples - Real-world usage patterns
- Performance Context - Why architectural decisions matter
- 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.