All documentation
Every page below is published from the repository's docs/ directory at build time, so this site cannot drift from the documentation it renders.
Guides
- Getting started with unify: The unify tutorial: install, scaffold a site, compose pages with includes, layouts and slots, and publish.
- Templates: start from one, stay current with it, publish your own: Scaffolding a site from a template, keeping it current with unify update, publishing your own, and building on one with extends.
- Authoring a unify site — the complete rules: unify composes plain HTML at build time.
- Integrating compiled components: the compile-to-asset pattern: Using a component framework, Svelte here, on a unify site by compiling it to an asset, without adopting a framework for the site.
- A blog list and search, from catalog.json and search-corpus.json: A blog index sorted newest-first with tag facets, and a search box, built from the catalog and the search corpus with a script you own.
- Eleventy inside --generate, htmx on top: Keeping a generator you already have, Eleventy here, and letting unify own every page's chrome, head, URLs and checks.
- Docker Usage Guide: The unify container image: what it contains, and how to build a site with it.
Reference
- unify CLI reference: Every unify command, option and exit code, and the unify.yaml keys that save them.
- unify — Product Specification: The shipped product contract: what unify is, who it serves, the composition model, the CLI and the boundaries future work must keep.
- unify — Conformance Specification: The implementer-grade reference: unify's exact behavior rule by rule, with every worked example a test fixture.
Project
- unify — Testing Strategy: The testing contract: what fully and correctly implemented means as machine-checkable conditions, and the tiers and gates that check them.
- CI/CD workflows: What each of unify's GitHub Actions workflows runs, and what a green or red job is allowed to mean.
- Ratification — what the agent-experiment rounds changed: The evidence behind the authoring rules: each ratification round, what it found, and what it changed in the docs, the spec and the code.
- Ratification: dialling in the rules with micro-experiments: How to validate the authoring rules empirically, by having agents author from them in isolation, and how to triage what fails.
- unify — Test-Suite and Codebase Migration Plan (v0.6 → v0.7.0): How the v0.6 test tree and codebase were migrated to the suite the testing strategy defines, and the gates that kept it honest.