Wit

The spec

A note on where the authoritative description of Wit lives, and where it is going.

What is authoritative instead

When two descriptions of Wit disagree, believe them in this order:

  • The code — the parser, runtime, and renderers as they build today.
  • The fixtures — verified input-and-snapshot pairs that pin every behaviour.
  • The examples — whole documents that build green.
  • The project docs — the README, plan, and changelog.

The old spec sits below all of these. Anything it claims must be confirmed against a fixture or a real build before you rely on it.

Reference is the new spec

The site's Reference section is built directly from code and fixtures and kept honest by live examples. As it fills out, it supersedes the standalone spec document: the plan is to deprecate and redirect the old spec once Reference is complete.

Interim guidance

If you must consult the old spec in the meantime, cross-check every claim. A one-line wit build or wit check settles most questions faster than reading prose that may have drifted.

The spec PDF

A spec PDF also lives in the repository under its own version tag. Like the Markdown spec, it is pending regeneration and carries the same caveat — verify against the fixtures.

See also

Architecture

describes the pipeline the fixtures test; Changelog tracks released behaviour.