Completed Phase 4 of the schema-of-schemas implementation with successful migration of all legacy schemas to the new markdown format following the naming convention. Migration Script (scripts/migrate_schemas.py - 240 lines): - Automated schema migration from JSON to markdown format - Updates version and $id fields to follow conventions - Generates proper frontmatter metadata - Dry-run mode for safe testing - Database cleanup functionality - Comprehensive progress reporting Schemas Migrated (2): - terminology-schema.json → terminology-schema-v1.0.md - Fixed missing version field - Updated $id from /terminology-v1.json to /terminology/v1.0 - Validates successfully against metaschema - api-documentation → api-documentation-schema-v1.0.md - Added version: 1.0.0 - Updated $id to follow /api-documentation/v1.0 format - Validates successfully against metaschema Schemas Deleted (3): - markdown-manpage (duplicate of manpage-schema-v1.0.md) - markdown-manpage-schema.json (duplicate of manpage-schema-v1.0.md) - enhanced-manpage (replaced by manpage-schema-v1.0.md) CLI Enhancement (markitect/cli.py): - Updated schema-ingest to support markdown (.md) files - Auto-detects file type and uses MarkdownSchemaLoader for .md files - Extracts JSON schema from markdown for database storage - Maintains backward compatibility with JSON files Final Schema Registry (4 schemas): ✅ terminology-schema-v1.0.md - Terminology validation ✅ api-documentation-schema-v1.0.md - API documentation structure ✅ manpage-schema-v1.0.md - Unix manual pages ✅ schema-schema-v1.0.md - Metaschema for validating schemas All schemas: - Follow naming convention: {domain}-schema-v{major}.{minor}.md - Include proper frontmatter with schema-id, version, status - Validate successfully against schema-schema-v1.0.md metaschema - Stored in database and ready for use Progress Tracking: - Updated TODO.md with Phase 4 completion - Updated CHANGELOG.md with migration details - Next: Phase 5 - CLI & Documentation Updates 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
238 lines
11 KiB
Markdown
238 lines
11 KiB
Markdown
# Todofile
|
|
|
|
This is a "to do next" file, particularly useful to keep the human and a coding assistant in sync.
|
|
|
|
The format is based on [Keep a Todofile V0.0.1](https://coulomb.social/open/KeepaTodofile).
|
|
|
|
The structure organizes **future tasks** by their impact, just as a changelog organizes past changes by their impact.
|
|
|
|
***
|
|
|
|
## [Unreleased] - *Active Vibe-Coding State* 💡
|
|
|
|
This section is for tasks currently being discussed with or worked on by the coding assistant. These are the ephemeral, flow-of-thought tasks.
|
|
|
|
### Schema-of-Schemas Implementation (Active - Phase 4)
|
|
|
|
**Status:** Phase 4 - Schema Migration (Completed ✅)
|
|
**Workplan:** See `roadmap/schema-of-schemas/WORKPLAN.md`
|
|
|
|
**Current Goals:**
|
|
1. ✅ Establish naming convention: `{domain}-schema-v{major}.{minor}.md`
|
|
2. ✅ Implement filename validation logic
|
|
3. ✅ Create markdown schema loader
|
|
4. ✅ Create example markdown schema
|
|
5. ✅ Build schema-for-schemas metaschema
|
|
6. ✅ Migrate existing schemas to new format
|
|
|
|
**Phase 1 Tasks (Completed ✅):**
|
|
- [x] Write `markitect/schema_naming.py` with validation logic
|
|
- [x] Add unit tests for filename validation (50 tests, 100% passing)
|
|
- [x] Create SCHEMA_NAMING_SPEC.md documentation
|
|
|
|
**Phase 2 Tasks (Completed ✅):**
|
|
- [x] Implement MarkdownSchemaLoader class (markitect/schema_loader.py, 515 lines)
|
|
- [x] Add frontmatter extraction (YAML)
|
|
- [x] Add JSON code block extraction with section preference
|
|
- [x] Add metadata merging with x-markitect-source tracking
|
|
- [x] Write comprehensive unit tests (35 tests, 100% passing)
|
|
- [x] Create example markdown schema (manpage-schema-v1.0.md)
|
|
- [x] Create SCHEMA_LOADER_GUIDE.md documentation
|
|
|
|
**Phase 3 Tasks (Completed ✅):**
|
|
- [x] Design schema-for-schemas metaschema (schema-schema-v1.0.md)
|
|
- [x] Implement metaschema with validation rules for MarkiTect conventions
|
|
- [x] Add schema-validate CLI command with detailed error reporting
|
|
- [x] Write comprehensive unit tests (12 tests, 100% passing)
|
|
- [x] Test metaschema self-validation
|
|
- [x] Validate existing schemas against metaschema
|
|
|
|
**Phase 4 Tasks (Completed ✅):**
|
|
- [x] Create migration script (scripts/migrate_schemas.py)
|
|
- [x] Migrate terminology-schema.json → terminology-schema-v1.0.md
|
|
- [x] Migrate api-documentation → api-documentation-schema-v1.0.md
|
|
- [x] Delete duplicate schemas (markdown-manpage, markdown-manpage-schema.json)
|
|
- [x] Delete replaced schema (enhanced-manpage)
|
|
- [x] Update schema-ingest CLI to support markdown files
|
|
- [x] Validate all migrated schemas
|
|
- [x] Ingest all markdown schemas into database
|
|
|
|
**Next Phases:**
|
|
- Phase 5: CLI & Documentation Updates (1 day)
|
|
- Phase 6: Testing & Validation (1 day)
|
|
|
|
**Expected Completion:** 2-3 days remaining
|
|
|
|
---
|
|
|
|
### Extract Capability-Capability from Issue-Facade (Paused)
|
|
|
|
**Context:** Issue-facade currently provides two capabilities:
|
|
1. **issue-tracking** (explicit in CAPABILITY-issue-tracking.yaml) - Issue management across platforms
|
|
2. **capability-capability** (implicit) - Patterns and tools for creating/managing capabilities
|
|
|
|
The **capability-capability** includes:
|
|
- Feedback pattern (feedback/ directory, .capability/feedback CLI tool, documentation)
|
|
- Detachment facility (.capability/detach script for clean capability removal)
|
|
- Integration pattern (.capability/integrate.sh for project integration)
|
|
- CAPABILITY-*.yaml specification format
|
|
- ReusableCapabilitiesArchitecture.md (complete specification)
|
|
- Directory conventions (_family/implementation, visible/hidden patterns)
|
|
|
|
**Goal:** Extract capability-capability to separate `reusable-capability` repository so it can be used by any capability in the markitect ecosystem.
|
|
|
|
**Approach:** Step-by-step extraction, starting with specification.
|
|
|
|
#### Phase 1: Specification & Planning (Current)
|
|
|
|
- [ ] Create CAPABILITY-capability.yaml in issue-facade to explicitly declare the implicit capability
|
|
- [ ] Define what belongs to capability-capability family vs issue-tracking family
|
|
- [ ] Document the capability-capability API surface (what tools/patterns it provides)
|
|
- [ ] Identify all files/directories to extract
|
|
- [ ] Plan extraction strategy (copy vs move, how to maintain during transition)
|
|
|
|
#### Phase 2: Repository Creation
|
|
|
|
- [ ] Create reusable-capability repository structure
|
|
- [ ] Extract ReusableCapabilitiesArchitecture.md to new repo
|
|
- [ ] Extract feedback pattern (directory structure, CLI tool, README)
|
|
- [ ] Extract detachment facility (.capability/detach)
|
|
- [ ] Extract integration scripts (.capability/integrate.sh, integration-checklist.md)
|
|
- [ ] Create CAPABILITY-capability.yaml in new repo (canonical version)
|
|
- [ ] Add README.md for reusable-capability repo
|
|
|
|
#### Phase 3: Integration & Testing
|
|
|
|
- [ ] Update issue-facade to depend on reusable-capability (as integrated capability)
|
|
- [ ] Integrate reusable-capability into issue-facade using _capability/reusable-capability pattern
|
|
- [ ] Test that issue-facade still works with extracted capability
|
|
- [ ] Update issue-facade documentation to reference both capabilities it provides/uses
|
|
- [ ] Verify feedback system still works
|
|
- [ ] Verify detachment still works
|
|
|
|
#### Phase 4: Dogfooding & Validation
|
|
|
|
- [ ] Choose another markitect capability for dogfooding
|
|
- [ ] Integrate reusable-capability into that capability
|
|
- [ ] Add feedback system to new capability
|
|
- [ ] Add detachment facility to new capability
|
|
- [ ] Document learnings and refine reusable-capability based on real-world usage
|
|
- [ ] Update ReusableCapabilitiesArchitecture.md with insights
|
|
|
|
**Current Step:** Phase 1, Task 1 - Create CAPABILITY-capability.yaml
|
|
|
|
***
|
|
|
|
## Completed Tasks
|
|
|
|
*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 & 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
|
|
- ✅ Created comprehensive test suite (33 unit tests, 100% passing)
|
|
- ✅ 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)
|
|
- Automatic detection of exact counts, const values, overly specific numbers
|
|
- Path navigation for nested schema properties
|
|
- Dry-run mode for previewing changes
|
|
- 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)
|
|
|
|
### 2026-01-04 - Phase 2: Markdown Schema Loader
|
|
- ✅ Implemented MarkdownSchemaLoader class (markitect/schema_loader.py, 515 lines)
|
|
- ✅ YAML frontmatter extraction with validation
|
|
- ✅ JSON code block extraction with "Schema Definition" section preference
|
|
- ✅ Metadata merging with x-markitect-source tracking
|
|
- ✅ Schema saving with template support and round-trip capability
|
|
- ✅ Comprehensive test suite (35 unit tests, 100% passing)
|
|
- ✅ Created example markdown schema (manpage-schema-v1.0.md)
|
|
- ✅ Created SCHEMA_LOADER_GUIDE.md with complete usage documentation
|
|
|
|
**Key Features Delivered:**
|
|
- Markdown-first schema format with embedded JSON
|
|
- Frontmatter metadata merges into schema ($id, version, status)
|
|
- Automatic detection of multiple JSON blocks
|
|
- Schema structure validation helper
|
|
- Error handling for binary files and invalid formats
|
|
- List JSON blocks helper for debugging
|
|
- Full round-trip save/load capability
|
|
|
|
**Example Markdown Schema:**
|
|
- manpage-schema-v1.0.md demonstrating complete format
|
|
- Includes frontmatter, documentation, and JSON schema
|
|
- Shows section classification and content control
|
|
- Follows naming convention: {domain}-schema-v{major}.{minor}.md
|
|
|
|
### 2026-01-04 - Phase 3: Schema-for-Schemas Metaschema
|
|
- ✅ Created schema-schema-v1.0.md metaschema (650+ lines)
|
|
- ✅ Validates core JSON Schema fields ($schema, $id, title, description)
|
|
- ✅ Validates MarkiTect version field (SemVer: major.minor.patch)
|
|
- ✅ Validates $id URL format (HTTPS with version)
|
|
- ✅ Validates MarkiTect extensions (x-markitect-sections, x-markitect-content-control, x-markitect-metadata)
|
|
- ✅ Implemented schema-validate CLI command with detailed error reporting
|
|
- ✅ Comprehensive test suite (12 unit tests, 100% passing)
|
|
- ✅ Metaschema self-validation successful
|
|
|
|
**Key Features Delivered:**
|
|
- Complete metaschema for validating all MarkiTect schemas
|
|
- Section classification validation (required, recommended, optional, discouraged, improper)
|
|
- Content control pattern validation
|
|
- Version format enforcement (SemVer)
|
|
- $id URL format enforcement (HTTPS with version)
|
|
- CLI command for easy schema validation
|
|
- Detailed error messages with schema paths
|
|
|
|
**Validation Results:**
|
|
- ✅ Metaschema validates itself
|
|
- ✅ Manpage schema validates successfully
|
|
- ⚠️ Terminology schema needs migration (missing version field, incorrect $id format)
|
|
|
|
### 2026-01-05 - Phase 4: Schema Migration
|
|
- ✅ Created migration script (scripts/migrate_schemas.py, 240 lines)
|
|
- ✅ Migrated 2 schemas to markdown format
|
|
- ✅ Deleted 3 duplicate/replaced schemas from database
|
|
- ✅ Updated schema-ingest CLI to support markdown files (.md)
|
|
- ✅ All 4 schemas now in markdown format following naming convention
|
|
|
|
**Schemas Migrated:**
|
|
- terminology-schema.json → terminology-schema-v1.0.md
|
|
- api-documentation → api-documentation-schema-v1.0.md
|
|
|
|
**Schemas Deleted:**
|
|
- markdown-manpage (duplicate)
|
|
- markdown-manpage-schema.json (duplicate)
|
|
- enhanced-manpage (replaced by manpage-schema-v1.0.md)
|
|
|
|
**Final Schema Registry:**
|
|
- ✅ terminology-schema-v1.0.md
|
|
- ✅ api-documentation-schema-v1.0.md
|
|
- ✅ manpage-schema-v1.0.md
|
|
- ✅ schema-schema-v1.0.md (metaschema)
|
|
|
|
All schemas validate successfully against the metaschema!
|
|
|
|
### 2025-12-17 - Architecture Refactoring
|
|
- ✅ Implemented ReusableCapabilitiesArchitecture v0.1
|
|
- ✅ Added feedback capability to issue-facade
|
|
- ✅ Created detachment facility
|
|
- ✅ Refactored to family-based directory structure (_issue-tracking/issue-facade)
|
|
- ✅ Made feedback directory visible (feedback/ not .feedback/)
|
|
- ✅ Renamed to explicit family declaration (CAPABILITY-issue-tracking.yaml)
|
|
- ✅ Created CHANGELOG.md documenting v1.0.0
|