markitect-main/docs

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

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.