tegwick
061ba88206
**Critical Fixes for v0.10.0 Release**:
1. **Fixed setuptools-scm Configuration** (pyproject.toml):
- Added git_describe_command with --match 'v*' pattern
- Prevents setuptools-scm from parsing non-version tags
- Resolves "markitect --version" returning "unknown"
- Version detection now works correctly (0.9.1.dev76)
2. **Retroactively Created v0.9.0 Git Tag**:
- Tagged commit b9c1b90 from 2025-11-14
- Maintains version history integrity
- CHANGELOG documented v0.9.0 but tag was missing
- Enables proper version progression to v0.10.0
3. **Prepared CHANGELOG.md for v0.10.0 Release**:
- Created [0.10.0] - 2026-01-06 section
- Moved all Unreleased content to v0.10.0
- Documented version detection fixes
- Documented v0.9.0 retroactive tag creation
**Issue Identified**: Non-version git tags (e.g.,
"testdrive-jsui-migration-phase4-complete") were causing
setuptools-scm to crash with AssertionError.
**Solution**: Configure git describe to only match version tags
using --match 'v*' pattern, filtering out non-version tags.
**Result**: Version command now works correctly, showing
development version based on v0.9.0 + 76 commits.
**Next Step**: Ready to proceed with Stage 2 (CHANGELOG schema)
per release-management-optimization workplan.
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.