An advanced markdown engine
tegwick
c46d9f7a0b
Comprehensively document the new classification system and content control features added in Phase 1. ## Documentation Updates ### New Content Added **1. Updated MarkiTect Extensions Section** - Replaced deprecated x-markitect-required/recommended-sections - Documented x-markitect-sections with five classification levels - Documented x-markitect-content-control for content validation **2. Added Section Classification System (150+ lines)** - Detailed explanation of all five classification levels: - required: Missing = ERROR - recommended: Missing = WARNING - optional: No validation impact - discouraged: Present = WARNING - improper: Present = ERROR - Validation behavior for each classification - JSON examples for each level **3. Added Content Control Documentation** - Pattern validation (required/discouraged/forbidden) - Content quality metrics (word count, readability targets) - Content instructions for authors - Complete examples with explanations **4. Updated Schema Design Best Practices** - Replaced old extension examples with new classification system - Added guidance on choosing appropriate classifications - Examples showing required, recommended, optional, discouraged, improper **5. Added Classification System Example** - Complete working schema demonstrating all features - Validation scenarios showing different outcomes - Integration of sections and content-control extensions ## Changes Summary **Lines Added**: ~200 lines of new documentation **Sections Updated**: 4 major sections **Examples Added**: 8 new code examples **Key Topics Covered**: - Five-level classification system (required → improper) - Content pattern validation - Quality metrics and readability targets - Content instructions for document authors - Validation behavior for each classification - Complete working examples ## Validation ✅ Manual validates against improved markdown-manpage-schema.json ✅ All new features documented with examples ✅ Backward compatibility maintained ✅ Self-documenting: manual uses the features it documents The manual now comprehensively documents the Phase 1 enhanced schema system while itself validating against a schema using those features. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> |
||
|---|---|---|
| .claude | ||
| .github/workflows | ||
| .issues | ||
| .venv_old | ||
| _issue-tracking | ||
| agents | ||
| application | ||
| assets | ||
| capabilities | ||
| config | ||
| cost_notes | ||
| docs | ||
| domain | ||
| examples | ||
| guides | ||
| history | ||
| infrastructure | ||
| issue_tracker/cli | ||
| markitect | ||
| node_modules | ||
| reports | ||
| scripts | ||
| services | ||
| src | ||
| testdata | ||
| tests | ||
| todo | ||
| tools | ||
| wiki@8818df03d3 | ||
| .clinerules | ||
| .gitignore | ||
| .gitmodules | ||
| aliases.sh | ||
| asset_registry.json | ||
| CHANGELOG.md | ||
| demo_plugin_integration.py | ||
| GUARDRAILS.md | ||
| install | ||
| install.py | ||
| install.sh | ||
| Makefile | ||
| package-lock.json | ||
| package.json | ||
| pyproject.toml | ||
| pytest-timeout.ini | ||
| pytest.ini | ||
| test_asset_deployment.py | ||
| test_browser_ready.py | ||
| test_cli_integration.py | ||
| test_cli_plugin.md | ||
| test_cli_simple.py | ||
| test_cli_with_assets.py | ||
| test_complete_integration.py | ||
| test_integration.md | ||
| test_plugin_discovery.py | ||
| test_strict_mode.html | ||
| TODO.html | ||
| TODO.md | ||
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.