How khronosgroup/vulkan-docs works
Main Components
a. Source Content Layer:
• XML Registry (vk.xml) - The core data source
• AsciiDoctor Content (chapters/, appendices/)
• Extension Proposals (proposals/)
• Style Guidelines (style/)
• Configuration Files (config/)
b. Build and Generation Layer:
• Scripts Engine (scripts/)
• Make System (Makefile)
• Generator Components
• Header Generator
• Documentation Generator
• Reference Page Generator
c. Output Layer:
• Generated Headers (include/vulkan/)
• Generated Documentation
• Generated Reference Pages
• Web Documentation (Antora)
• [Source Content] → [Build/Generation] → [Output Artifacts]
Component Relationships
• XML Registry feeding into header generation
• AsciiDoctor content feeding into documentation generation
• Configuration files influencing build processes
• Build scripts orchestrating the generation process
Specific Implementation Details
[XML Registry (vk.xml)] ─────┐
[AsciiDoctor Content] ───────┼─→ [Build System] → [Generated Artifacts]
• ↑
[Configuration Files] ───────┘ │
[Scripts and Tools] ─────────────────-┘
Key Elements to Highlight
a. Core Processing Flow:
• XML parsing and validation
• Content generation pipelines
• Documentation building process
• Output formatting and organization
b. Support Systems:
• Version control integration
• Build automation
• Quality control tools
• Testing framework