Skip to content

Add schema-spec alignment, documentation, and tooling improvements#19

Merged
gvonness-apolitical merged 1 commit intomainfrom
feature/cleanup-consistency
Feb 1, 2026
Merged

Add schema-spec alignment, documentation, and tooling improvements#19
gvonness-apolitical merged 1 commit intomainfrom
feature/cleanup-consistency

Conversation

@gvonness-apolitical
Copy link
Collaborator

Summary

This PR implements a comprehensive cleanup and consistency plan for the Codex specification:

  • Schema-Spec Alignment: Added missing schema definitions for documented features
  • Documentation: Expanded terminology glossary, added hashing boundary summary
  • New Extension: Created Legal Extension for Table of Authorities
  • Tooling: Added scripts for spec-schema sync checking, cross-reference validation, and template generation
  • Examples: Added presentation-document example demonstrating book layout features

Changes

Schema Changes

  • Add presentation:reference block to presentation schema
  • Add indexMark to presentation schema (for index generation)
  • Add semantic property to blockAttributes in content schema
  • Add config property to extension definitions in manifest schema
  • Expand presentation schema with layout, print, master pages, typography, floats, TOC, footnotes
  • Add code syntax highlighting tokens to codeBlock schema
  • Create legal.schema.json for Table of Authorities and legal citations

Documentation Improvements

  • Expand terminology glossary in 00-introduction.md with clear definitions for Block, Mark, Annotation, Element, etc.
  • Add hash boundary summary table to 06-document-hashing.md
  • Add syntax highlighting section to 03-content-blocks.md
  • Create Legal Extension spec (spec/extensions/legal/README.md)
  • Rename archive files with descriptive topic summaries

New Tooling

  • scripts/check-spec-schema-sync.ts - Detects drift between spec documentation and schemas
  • scripts/validate-cross-refs.ts - Validates internal references in spec markdown
  • scripts/generate-template.ts - Generates minimal valid documents for extension combinations

Examples

  • Add examples/presentation-document/ demonstrating master pages, typography, multi-column layout, running headers/footers

Test plan

  • All schemas compile successfully
  • All example documents validate against schemas
  • New scripts run without errors

Schema Changes:
- Add presentation:reference block and indexMark to presentation schema
- Add semantic property to blockAttributes in content schema
- Add extension config support to manifest schema
- Expand presentation schema with layout, print, master pages, typography
- Add code syntax highlighting tokens to codeBlock schema
- Create legal extension schema (Table of Authorities, citations)

Documentation:
- Expand terminology glossary in 00-introduction.md
- Add hashing boundary summary table to 06-document-hashing.md
- Add syntax highlighting section to 03-content-blocks.md
- Create legal extension spec with citation formats
- Rename archive files with topic summaries

Tooling:
- Add spec-schema sync checker script
- Add cross-reference validator script
- Add document template generator script
- Update validation scripts for new dependencies

Examples:
- Add presentation-document example with book layout
@gvonness-apolitical gvonness-apolitical merged commit 7e4152a into main Feb 1, 2026
2 checks passed
@gvonness-apolitical gvonness-apolitical deleted the feature/cleanup-consistency branch February 1, 2026 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant