95 lines
2.6 KiB
Markdown
95 lines
2.6 KiB
Markdown
|
# Schema-of-Schemas Implementation
|
||
|
|
|
||
|
|
**Project:** Markdown-First Schema System
|
||
|
|
**Status:** Planning → Implementation
|
||
|
|
**Timeline:** 8-10 days
|
||
|
|
|
||
|
|
## Quick Links
|
||
|
|
|
||
|
|
- **[WORKPLAN.md](./WORKPLAN.md)** - Detailed implementation plan with phases
|
||
|
|
- **[SCHEMA_MANAGEMENT_PROPOSAL.md](./SCHEMA_MANAGEMENT_PROPOSAL.md)** - Full analysis and options
|
||
|
|
- **[SCHEMA_MANAGEMENT_SUMMARY.md](./SCHEMA_MANAGEMENT_SUMMARY.md)** - Executive summary
|
||
|
|
|
||
|
|
## What We're Building
|
||
|
|
|
||
|
|
### Goals
|
||
|
|
1. ✅ Filename convention: `{domain}-schema-v{version}.md`
|
||
|
|
2. ✅ Markdown-first schema format (documentation + embedded JSON)
|
||
|
|
3. ✅ Schema-for-schemas to validate all schemas
|
||
|
|
4. ✅ Migrate existing schemas to new format
|
||
|
|
5. ✅ Clean up duplicate/legacy schemas
|
||
|
|
|
||
|
|
### Why
|
||
|
|
- **Consistency:** Enforced naming and versioning
|
||
|
|
- **Alignment:** Markdown-first matches MarkiTect philosophy
|
||
|
|
- **Documentation:** Rich docs alongside schemas
|
||
|
|
- **Validation:** Schema-for-schemas ensures quality
|
||
|
|
- **Maintainability:** Clear versions and structure
|
||
|
|
|
||
|
|
## Implementation Phases
|
||
|
|
|
||
|
|
1. **Phase 0:** Planning & Setup (0.5 days) ← **Current**
|
||
|
|
2. **Phase 1:** Filename Convention (1 day)
|
||
|
|
3. **Phase 2:** Markdown Loader (2-3 days)
|
||
|
|
4. **Phase 3:** Schema-for-Schemas (2 days)
|
||
|
|
5. **Phase 4:** Schema Migration (1-2 days)
|
||
|
|
6. **Phase 5:** CLI & Docs (1 day)
|
||
|
|
7. **Phase 6:** Testing (1 day)
|
||
|
|
|
||
|
|
## Current Status
|
||
|
|
|
||
|
|
### Completed
|
||
|
|
- [x] Directory structure created
|
||
|
|
- [x] Planning documents moved to roadmap
|
||
|
|
- [x] Comprehensive workplan written
|
||
|
|
- [x] Example markdown schema created
|
||
|
|
|
||
|
|
### Next Steps
|
||
|
|
1. Complete Phase 0 planning artifacts
|
||
|
|
2. Begin Phase 1 implementation
|
||
|
|
3. Checkpoint review after Phase 1
|
||
|
|
|
||
|
|
## Key Decisions
|
||
|
|
|
||
|
|
### Naming Convention
|
||
|
|
**Format:** `{domain}-schema-v{major}.{minor}.md`
|
||
|
|
**Example:** `manpage-schema-v1.0.md`
|
||
|
|
|
||
|
|
### Schema Format
|
||
|
|
**Markdown with embedded JSON:**
|
||
|
|
```markdown
|
||
|
|
---
|
||
|
|
schema-id: "https://markitect.dev/schemas/manpage/v1"
|
||
|
|
version: "1.0.0"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Manpage Schema v1.0
|
||
|
|
|
||
|
|
[Documentation...]
|
||
|
|
|
||
|
|
## Schema Definition
|
||
|
|
|
||
|
|
```json
|
||
|
|
{ ... JSON schema ... }
|
||
|
|
```
|
||
|
|
```
|
||
|
|
|
||
|
|
### Schema Migration Plan
|
||
|
|
```
|
||
|
|
Old → New
|
||
|
|
──────────────────────────────────────────────────
|
||
|
|
terminology-schema.json → terminology-schema-v1.0.md
|
||
|
|
api-documentation → api-documentation-schema-v1.0.md
|
||
|
|
enhanced-manpage → manpage-schema-v2.0.md
|
||
|
|
markdown-manpage → REMOVE (duplicate)
|
||
|
|
markdown-manpage-schema.json → REMOVE (duplicate)
|
||
|
|
```
|
||
|
|
|
||
|
|
## Progress Tracking
|
||
|
|
|
||
|
|
Track progress in: `roadmap/schema-of-schemas/IMPLEMENTATION_LOG.md` (to be created)
|
||
|
|
|
||
|
|
## Questions?
|
||
|
|
|
||
|
|
See the full workplan for detailed implementation steps, risks, and mitigation strategies.
|