Documentation Templates¶
Reusable templates for consistent documentation across the Zer0-Mistakes project.
Templates¶
| Template | Use when |
|---|---|
| Feature Documentation | Documenting a new theme feature or component |
| Release Notes | Publishing a versioned release |
| Change Tracking | Recording a significant code change or bug fix |
Completed Examples¶
Before using a template, review a completed example:
| Template | Completed example |
|---|---|
| Feature documentation | Nanobar Component |
| Feature documentation | Copilot Prompt Button |
| Release notes | v0.3.0 Release Notes |
| Change tracking | Lint Pages Fixes |
How to Use¶
- Copy the template to the appropriate subdirectory (
docs/features/,docs/implementation/,docs/releases/) - Fill in the front matter fields (
title,description,date,lastmod,tags) - Replace placeholder text with real content — delete sections that don't apply
- Run
./scripts/docs/lint-frontmatter.shto verify compliance - Open a PR; CI will run link checking and markdownlint
Front Matter Requirement¶
Every new doc needs the standard front matter. The template files include it as a starting point. Run ./scripts/docs/lint-frontmatter.sh --fix on any file missing it.