Skip to content

Templates

templates/ in the platform repo holds the reusable pieces that go into KB repos and docs sites: deploy workflows, document templates, section generators, and feature schemas.

Deploy workflow

templates/workflows/deploy.yml is the canonical KB deploy pipeline: Zensical strict build → source-metadata injection → Cloudflare Pages deploy. Copy it into a new KB repo and set --project-name=<kb-id>. Details in Publishing.

Document templates

  • README.template.md — starting README for a KB repo.
  • ARCHITECTURE.md, CONTRIBUTING.md — skeletons a KB can adopt for its own meta-documentation.
  • _headers, robots.txt — static hosting headers and crawler defaults.

Section generators

templates/sections/ contains prompt-driven generators for common docs sections. Each generator is a pair:

  • recipe.md — what the section is, when to use it, its structure
  • prompt.md — the prompt an agent runs to draft the section from repo context

Available sections: context, requirements, decisions, architecture, glossary.

Feature flags

templates/features.schema.json defines the per-KB feature manifest (features.json): changelog, sitemap, page metadata, references, navigation, and search toggles. features.example.json shows a filled-in example.

Add-ons and code blocks

  • templates/add-ons.json — optional add-on catalog for docs sites.
  • templates/codeblocks/ — reusable code-block snippets.
  • templates/search/ — search wiring for published sites.
  • templates/nav.css — shared navigation styles.