tegwick
916c09a22b
Document plan to extract the implicit 'capability-capability' from issue-facade into a separate reusable-capability repository. Issue-facade currently provides two capabilities: 1. issue-tracking (explicit) - Issue management across platforms 2. capability-capability (implicit) - Patterns for creating/managing capabilities The capability-capability includes: - Feedback pattern and tooling - Detachment facility - Integration scripts - CAPABILITY-*.yaml specification format - ReusableCapabilitiesArchitecture.md - Directory conventions (_family/implementation, visible/hidden) Extraction plan divided into 4 phases: Phase 1: Specification & Planning - Create CAPABILITY-capability.yaml to declare the implicit capability - Define boundaries between families - Document API surface - Identify files to extract - Plan extraction strategy Phase 2: Repository Creation - Create reusable-capability repo - Extract all capability-capability files - Create canonical CAPABILITY-capability.yaml Phase 3: Integration & Testing - Integrate reusable-capability into issue-facade - Test functionality still works - Update documentation Phase 4: Dogfooding & Validation - Use in another capability - Validate and refine based on real usage Also documented completed tasks from today's architecture refactoring. Current step: Phase 1, Task 1 - Create CAPABILITY-capability.yaml
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.