tegwick
4e9117ddcb
Created comprehensive staged workplan for enhancing release management infrastructure with robust validation using the schema system. **Critical Issues Identified**: - setuptools-scm missing tag_regex configuration - markitect --version returns 'unknown' instead of actual version - CHANGELOG shows v0.9.0 (2025-11-14) but git tag never created - No validation for CHANGELOG format or version-tag consistency **Solution Approach**: Create changelog-schema-v1.0.md to validate Keep a Changelog format, demonstrating schema evolution in real-world use case. **Staged Workplan**: - Stage 1 (45 min): Critical fixes to unblock v0.10.0 release - Stage 2 (2.5 hrs): CHANGELOG schema creation and validation - Stage 3 (2 hrs): Release capability enhancements - Stage 4 (optional): Schema system extensions **Showcase Feature**: 'The release that validates itself' - v0.10.0 uses its own schema system to validate its CHANGELOG - Perfect demonstration of schema evolution practical value **Next Version**: v0.10.0 (not v0.9.0) - CHANGELOG already shows v0.9.0 as released - Must maintain version history integrity
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.