Fontshow Documentation¶
Getting started¶
Command documentation¶
Each command in the Fontshow pipeline has a dedicated documentation page describing its behavior, inputs, outputs, and validation rules.
The authoritative command documentation is located under:
-
Preflight checks →
tools/preflight.md -
Font inspection and metadata extraction →
tools/dump-fonts.md -
Inventory parsing and validation →
tools/parse-inventory.md -
Inventory validation →
tools/validate-inventory.md -
Catalog generation →
tools/create-catalog.md
These documents describe how each stage behaves, while the pipeline documentation describes how the stages relate to each other.
Data model¶
Development and maintenance¶
- Repository architecture
- Codebase map
- Development environment
- Development scripts
- Logging system
- Contributing guidelines
- CLI Contract
The architecture document explains the main structural boundaries of the project. The codebase map complements it with a developer-oriented guide to package responsibilities, data flow, change points, and bug triage entrypoints.
Engineering Notes (internal)¶
These notes are not part of the public API or user documentation, but serve as long-term project memory for maintainers.
Project planning and governance¶
Fontshow development is guided by a canonical, version-controlled planning and governance document set, maintained directly in the repository.
The planning set defines:
- development phases and milestones
- issue and atomic action models
- testing and stabilization strategy
-
governance and evolution guidelines
- Issue 66 persisted loadability implementation plan
Formal architectural and project decisions are tracked as individual, immutable records to preserve rationale and historical context.