tegwick
4faadb7ecd
Twelve required chapters, checklist recommended. First-wave estate documents validate against it.
91 lines
2.9 KiB
YAML
91 lines
2.9 KiB
YAML
# MarkiTect Schema Catalog
|
||
#
|
||
# This catalog provides metadata about available schemas for markdown document validation.
|
||
# Schemas can be referenced by name or loaded from their file path.
|
||
|
||
version: "1.0"
|
||
description: "Catalog of registered MarkiTect schemas for document validation"
|
||
|
||
schemas:
|
||
- id: "markitect-metaschema"
|
||
name: "MarkiTect Metaschema"
|
||
file: "markitect-metaschema.json"
|
||
version: "1.0"
|
||
description: "Metaschema for validating MarkiTect schema extensions"
|
||
type: "metaschema"
|
||
usage: "Used internally to validate schema files with MarkiTect-specific extensions"
|
||
tags:
|
||
- internal
|
||
- validation
|
||
- metaschema
|
||
|
||
- id: "terminology-v1"
|
||
name: "Terminology Document Schema"
|
||
file: "terminology-schema.json"
|
||
version: "1.0"
|
||
description: "Schema for validating terminology and glossary documents"
|
||
type: "document-schema"
|
||
usage: "Validates technical glossaries, terminology documents, and definition lists"
|
||
document_types:
|
||
- glossary
|
||
- terminology
|
||
- lexicon
|
||
- dictionary
|
||
features:
|
||
- Heading hierarchy validation (H1 → H2 → H3)
|
||
- Term structure validation (Definition, Synonyms, Related Terms, etc.)
|
||
- Content quality metrics (word counts, readability)
|
||
- MarkiTect extensions (x-markitect-sections, x-markitect-content-control)
|
||
- Classification system (required/recommended/optional)
|
||
example: "examples/terminology/terminology-example.md"
|
||
tags:
|
||
- documentation
|
||
- glossary
|
||
- terminology
|
||
- definitions
|
||
related_schemas: []
|
||
author: "MarkiTect Project"
|
||
created: "2026-01-04"
|
||
updated: "2026-01-04"
|
||
|
||
- id: "arc42-v1"
|
||
name: "arc42 Architecture Documentation Schema"
|
||
file: "arc42-schema-v1.0.md"
|
||
version: "1.0"
|
||
description: "Schema for a single-file arc42 architecture document (chapters 1–12 required)"
|
||
type: "document-schema"
|
||
usage: "Validates first-wave and complete arc42 system documents"
|
||
document_types:
|
||
- architecture
|
||
- arc42
|
||
tags:
|
||
- documentation
|
||
- architecture
|
||
- arc42
|
||
author: "MarkiTect Project"
|
||
created: "2026-08-19"
|
||
updated: "2026-08-19"
|
||
|
||
# Future schemas to add:
|
||
#
|
||
# - id: "manpage-v1"
|
||
# name: "Unix Manual Page Schema"
|
||
# description: "Schema for Unix/Linux manual page documentation"
|
||
#
|
||
# - id: "api-reference-v1"
|
||
# name: "API Reference Schema"
|
||
# description: "Schema for API endpoint documentation"
|
||
#
|
||
# - id: "adr-v1"
|
||
# name: "Architecture Decision Record Schema"
|
||
# description: "Schema for ADR (Architecture Decision Record) documents"
|
||
#
|
||
# - id: "rfc-v1"
|
||
# name: "RFC/Specification Schema"
|
||
# description: "Schema for RFC-style specification documents"
|
||
|
||
# Schema discovery paths:
|
||
# - Built-in: markitect/schemas/*.json
|
||
# - User-defined: ~/.markitect/schemas/*.json
|
||
# - Project-specific: .markitect/schemas/*.json
|
||
# - Custom paths via MARKITECT_SCHEMA_PATH environment variable
|