feat: add terminology schema example and improve schema-list command
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>
This commit is contained in:
12
TODO.md
12
TODO.md
@@ -76,7 +76,7 @@ The **capability-capability** includes:
|
||||
|
||||
*Recent completed tasks have been documented in _issue-tracking/issue-facade/CHANGELOG.md following Keep a Changelog format.*
|
||||
|
||||
### 2026-01-04 - Phase 2: Schema Refinement Tools
|
||||
### 2026-01-04 - Phase 2: Schema Refinement Tools & Terminology Example
|
||||
- ✅ Implemented schema-analyze command to detect rigidity issues
|
||||
- ✅ Implemented schema-refine command with automatic loosening logic
|
||||
- ✅ Added interactive mode to schema-refine for fine-grained control
|
||||
@@ -84,6 +84,8 @@ The **capability-capability** includes:
|
||||
- ✅ Wrote user guide documentation with examples and workflows
|
||||
- ✅ Successfully tested on example schemas (reduced rigidity from 60/100 to 24/100)
|
||||
- ✅ Integrated into CLI with proper exit codes and error handling
|
||||
- ✅ Moved SCHEMA_EVOLUTION_WORKPLAN.md to todo/ directory
|
||||
- ✅ Created terminology validation example (examples/terminology/)
|
||||
|
||||
**Key Features Delivered:**
|
||||
- Rigidity score calculation (0-100 scale)
|
||||
@@ -93,6 +95,14 @@ The **capability-capability** includes:
|
||||
- Interactive approval workflow
|
||||
- Comprehensive reporting (normal and verbose modes)
|
||||
|
||||
**Terminology Example:**
|
||||
- Complete terminology document structure (terminology-example.md)
|
||||
- JSON schema with MarkiTect extensions (terminology-schema.json)
|
||||
- Demonstrates schema usage for non-manpage documents
|
||||
- Validates term definitions, synonyms, related terms, examples
|
||||
- Includes content control and validation rules
|
||||
- Full documentation and usage examples (README.md)
|
||||
|
||||
### 2025-12-17 - Architecture Refactoring
|
||||
- ✅ Implemented ReusableCapabilitiesArchitecture v0.1
|
||||
- ✅ Added feedback capability to issue-facade
|
||||
|
||||
Reference in New Issue
Block a user