-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Description
Generate MyST markdown documentation from the JSON Schema definitions. Create documentation in docs/types/ with:
Generated files
- One markdown file per type (e.g.,
docs/types/Document.myst,docs/types/Heading.myst) - Include type description, properties table, and examples
- Cross-link related types
Codegen integration
- Implement
scripts/lib/generate-docs.ts - Register in
scripts/codegen.tsgenerators array - Add
pnpm codegen docscommand
Documentation structure
- Title from schema title or type name
- Description from schema description
- Properties table with name, type, required, and description columns
- Examples section if schema has examples defined
Tasks
- Implement
scripts/lib/generate-docs.ts - Register docs generator in
scripts/codegen.ts - Create
docs/types/directory structure - Run
pnpm codegen docsand verify generated markdown - Ensure cross-references between types work correctly
Metadata
Metadata
Assignees
Labels
No labels