This commit completes Phase 2 of schema evolution work and establishes
a new example demonstrating schema usage for terminology documents.
## New Features
### Terminology Validation Example (examples/terminology/)
- Complete example terminology document with proper structure
- JSON schema with MarkiTect extensions for validation
- Demonstrates schema usage beyond manpages (glossaries, lexicons)
- Validates term structure: Definition, Synonyms, Related Terms, Examples
- Includes content control and quality validation rules
- Full documentation with usage examples and best practices
### Schema Registration System
- Registered terminology schema in markitect database
- Created schema catalog (markitect/schemas/schema-catalog.yaml)
- Copied schema to official location (markitect/schemas/)
- Provides metadata, features, and usage info for all schemas
### Improved schema-list Command
- Now displays creation timestamps in default output
- Table format includes Created/Updated columns
- Cleaner timestamp formatting (removed microseconds)
- Better visibility into when schemas were added
## Files Changed
Added:
- examples/terminology/README.md - Complete documentation
- examples/terminology/terminology-example.md - Example glossary
- examples/terminology/terminology-schema.json - Validation schema
- markitect/schemas/terminology-schema.json - Registered schema
- markitect/schemas/schema-catalog.yaml - Schema registry
Modified:
- markitect/cli.py - Enhanced schema-list with timestamps
- TODO.md - Documented Phase 2 completion and new example
Moved:
- SCHEMA_EVOLUTION_WORKPLAN.md → todo/ directory
## Schema Features Demonstrated
- Heading hierarchy validation (H1 → H2 → H3)
- Term structure validation with required/optional fields
- Content quality metrics (word counts, readability targets)
- MarkiTect extensions (x-markitect-sections, x-markitect-content-control)
- Classification system (required/recommended/optional/discouraged/improper)
## Usage
```bash
# List schemas with timestamps
markitect schema-list
# Validate terminology document
markitect validate glossary.md --schema terminology-schema.json
# View in table format
markitect schema-list --format table
```
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
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>
Add comprehensive example showcasing schema validation with self-documenting
manpage system:
- markdown-manpage-schema.json: Reusable schema for Unix manpage structure
- markdown-schema-validation.1.md: Complete manual about schema validation
- README.md: Usage guide, integration examples, and best practices
- SCHEMA_EVOLUTION_WORKPLAN.md: Roadmap for enhanced schema system
The manual validates against its own schema, demonstrating dogfooding
principle. Workplan outlines 5-phase evolution from rigid structural
validation to flexible content control with blueprints.
Key features demonstrated:
- Schema-driven documentation structure
- Self-validating documentation
- Reusable validation patterns
- Classification system design (required/recommended/optional/discouraged/improper)
This sets foundation for Phase 1 implementation: enhanced schema format
with section classification and content control.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add Design Pattern Documentation:
- Add CopyFirstMigration.md - Documents the copy-first migration principle
used in the TestDrive-JSUI capability migration
- Add DontRepeatYourself.md - Documents the DRY principle
- Add DesignPrincipleSchema.json - JSON schema for design pattern documentation
Update Submodule:
- Update testdrive-jsui submodule pointer to include Phase 4 documentation
(migration completion with legacy file cleanup)
Context:
These design pattern examples document the principles applied during the
successful TestDrive-JSUI migration, which serves as a reference implementation
of the copy-first migration pattern.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
Asset Management System (Issue #142):
- Add complete asset management framework with deduplication
- Implement AssetManager, AssetRegistry, and AssetDeduplicator classes
- Add AssetPackager for markdown document packaging
- Create comprehensive test suite for all asset management components
- Add asset constants and custom exceptions for robust error handling
Markdown Processing Enhancements:
- Update markdown_commands.py with improved functionality
- Enhanced parsing and content aggregation capabilities
- Improved filename encoding/decoding for special characters
Test Suite Improvements:
- Add comprehensive tests for Issue #138 markdown parsing
- Enhance Issue #139 content aggregation and end-to-end testing
- Complete test coverage for new asset management features
Examples and Documentation:
- Update BildungsKanonJon.md example with enhanced content
- Generate corresponding HTML output for documentation
- Add asset registry configuration
Development Tools:
- Add install script for simplified setup
This commit represents a major enhancement to MarkiTect's asset handling
capabilities with full test coverage and improved markdown processing.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
Comprehensive analysis and implementation concepts for handling images and file includes
with automatic deduplication based on MarkdownPackageFormats wiki study.
## Two Complete Concepts Delivered
### Concept A: Hash-Based Asset Store
- Content-addressable storage using SHA-256 hashes
- SQLite database for virtual name mapping and metadata
- Perfect deduplication regardless of filename
- Hash-based directory structure for optimal storage
- Working prototype with 47 KB of implementation code
### Concept B: Package + Symlinks System (RECOMMENDED)
- ZIP-based .mdpkg packages following wiki standards
- Symlink-based deduplication in shared asset library
- Compatible with standard tools and workflows
- Visual transparency and tool integration
- Working prototype with 51 KB of implementation code
## Key Features Demonstrated
- ✅ Content deduplication: Same image content → single storage
- ✅ Multiple names: Different filenames for identical content
- ✅ Database integration: Asset metadata queryable and indexed
- ✅ Package portability: ZIP-based distribution format
- ✅ Working demos: Both concepts fully functional
## Analysis Results
- **Perfect Deduplication**: Both concepts eliminate duplicate content storage
- **Implementation Complexity**: Concept B more approachable, Concept A more efficient
- **Platform Compatibility**: Concept A universal, Concept B symlink-dependent
- **User Experience**: Concept B familiar workflows, Concept A requires tooling
## Technical Approach
- Based on MarkdownPackageFormats wiki standards (.mdpkg, .mdz formats)
- Python standard library (hashlib, sqlite3, zipfile, pathlib)
- Content-addressable storage patterns for efficiency
- Manifest-based metadata for package integrity
## Recommendations
1. **Start with Concept B** for rapid prototyping and user acceptance
2. **Evolve to hybrid approach** incorporating Concept A's hash-based efficiency
3. **Follow .mdpkg standards** for interoperability with emerging ecosystem
4. **Implement CLI integration** for seamless markitect workflow
Both concepts solve the core requirements with working prototypes and clear trade-offs.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
- Created invoice template demonstrating business document requirements
- Added design pattern example showing knowledge management use case
- Included sample data file for template + data scenarios
- Comprehensive gap analysis identifying 6 critical tooling limitations
- Documented 3-phase development roadmap for enhanced capabilities
- Based on Issue #63 use case brainstorming requirements
Key gaps identified:
1. Template engine for dynamic document generation
2. Calculation system for mathematical operations
3. Batch processing for multi-document workflows
4. External data integration capabilities
5. Cross-document relationship management
6. Advanced output format support
Ready for requirements engineering and epic decomposition.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
## Major Integration
- ✅ Integrated Requirements Engineering Agent into development workflow
- ✅ Enhanced Makefile with requirements validation targets
- ✅ Added pre-commit validation with mock compatibility checking
- ✅ Enhanced TDD workflow to include foundation analysis
## Test Fixes
- ✅ Fixed GiteaPlugin missing _add_comment_async method
- ✅ Fixed LocalPlugin config.yml file not found errors in tests
- ✅ Enhanced mock objects in CLI tests with proper domain model attributes
- ✅ All Issue #59 tests now passing (38/38 tests pass)
## New Capabilities
- `make validate-requirements` - Foundation analysis before development
- `make check-interface-compatibility INTERFACE=Name` - Interface compatibility checking
- `make generate-dev-checklist FEATURE='Name'` - Development checklist generation
- `make validate-mocks` - Mock object compatibility validation
- `make pre-commit-validate` - Complete pre-commit validation workflow
## Problem Prevention
This integration prevents the exact interface compatibility issues and mock object
mismatches that caused hours of debugging in Issue #59. The Requirements Engineering
Agent provides proactive foundation analysis and catches problems before they occur.
🤖 Generated with Claude Code
Co-Authored-By: Claude <noreply@anthropic.com>
