|
|
d68e762612
|
feat: implement Phase 1 - Enhanced Schema Format with Classifications
Complete Phase 1 of Schema Evolution Workplan implementing flexible content
control and section classification system.
## New Features
### 1. x-markitect-sections Extension
- Five classification levels: required, recommended, optional, discouraged, improper
- Per-section content constraints (paragraphs, code blocks, lists)
- Position hints for section ordering
- Custom error/warning messages
- Alternative section names support
- Content instructions for authors
### 2. x-markitect-content-control Extension
- Required/discouraged/forbidden pattern matching
- Content quality metrics (word count, readability target, sentence count)
- Content instruction arrays
- Link validation configuration
### 3. Metaschema Validation
- Updated markitect-metaschema.json with complete validation rules
- Enhanced metaschema.py with validation methods for both extensions
- Comprehensive validation of all extension properties
- Clear error messages for invalid schemas
### 4. Documentation & Examples
- Complete specification in docs/specifications/schema-extensions-spec.md
- Enhanced manpage schema demonstrating all 5 classification levels
- API documentation schema showing alternative patterns
- Detailed usage examples and validation behavior
## Implementation Details
**Files Modified:**
- markitect/schemas/markitect-metaschema.json: Added extension definitions
- markitect/metaschema.py: Added _validate_sections() and _validate_content_control()
**Files Created:**
- docs/specifications/schema-extensions-spec.md: Complete specification (v1.0)
- examples/manpages/enhanced-manpage-schema.json: Demonstrates all classifications
- examples/manpages/api-documentation-schema.json: Shows API doc patterns
## Validation Behavior
**Classification Levels:**
- required: Missing = ERROR (validation fails)
- recommended: Missing = WARNING (validation succeeds with warnings)
- optional: No validation impact
- discouraged: Present = WARNING (validation succeeds with warnings)
- improper: Present = ERROR (validation fails)
## Next Steps
Phase 2: Schema Refinement Tools (schema-analyze, schema-refine, schema-compose)
Phase 3: Enhanced Validation Engine (classification-aware validation, quality metrics)
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
2026-01-04 21:02:51 +01:00 |
|
|
|
22008875d3
|
feat: Complete Issue #50 - Define metaschema for JSON schema structure
Implement comprehensive MarkiTect metaschema that extends standard JSON Schema
with MarkiTect-specific features for document analysis and generation.
🎯 TDD8 Implementation Complete:
- ISSUE: Analyzed existing schema system and requirements
- TEST: 15 comprehensive tests covering all features
- RED: Verified tests fail before implementation
- GREEN: Implemented metaschema JSON and validation logic
- REFACTOR: Clean, extensible validator architecture
- DOCUMENT: Updated CLI help and comprehensive documentation
- REFINE: 100% test success rate and CLI integration
- PUBLISH: Ready for production use
✅ Key Features Implemented:
- Heading text capture support (x-markitect-heading-text)
- Content field instructions (x-markitect-content-instructions)
- Outline structure representation (x-markitect-outline-mode/depth)
- Backward compatibility with existing schemas
- Validation rules for all new features
- CLI integration in schema-ingest command
📁 Files Added:
- markitect/metaschema.py - Validation logic and MetaschemaValidator
- markitect/schemas/markitect-metaschema.json - Metaschema definition
- Enhanced markitect/cli.py - Automatic metaschema validation
🧪 Testing:
- 15 comprehensive tests (100% passing)
- RED-GREEN-REFACTOR cycle validated
- CLI integration tested and working
- Backward compatibility verified
📋 Acceptance Criteria Met:
✅ Schema metaschema supports heading text capture
✅ Schema metaschema supports content field instructions
✅ Schema metaschema supports outline structure representation
✅ Schema metaschema is backward compatible with existing schemas
✅ Schema metaschema includes validation rules for new features
✅ Documentation explains the metaschema structure and usage
🔗 Foundation for Future Issues:
- Issue #51: Outline mode schema generation
- Issue #52: Heading text capture in schemas
- Issue #54: Content instruction capabilities
- Issue #55: Schema-based draft generation
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
|
2025-10-01 02:39:29 +02:00 |
|
