# wiki-builder

> the tool's own wiki

## Start

- [wiki-builder](index.md): a tool that renders markdown into a wiki, and refuses what makes documentation rot
- [Brief](brief/index.md): what wiki-builder is, who it is for, and what it refuses
- [Goals](goals/index.md): what every part of the tool is for

## Guides

- [Installation](installation/index.md): starting a wiki in a project
- [Continuous integration](continuous-integration/index.md): the check on every push, here and in any project
- [Deployment (GitHub)](deployment-github/index.md): publishing a wiki on GitHub
- [Deployment (Cloudflare)](deployment-cloudflare/index.md): publishing a wiki on Cloudflare

## Writing

- [Pages](pages/index.md): what a person writes
- [Diagrams](pages/diagrams/index.md): flowcharts and other drawings, written as text
- [Skill](skill/index.md): how an agent learns to write a page

## Reading

- [Site](site/index.md): what a build makes
- [Agent markdown](site/agent-markdown/index.md): what an agent reads instead of the rendered page
- [Layout](site/layout/index.md): how a page sits on the screen
- [Local server](serving/index.md): reading the wiki on this machine

## Checking

- [Checks](checks/index.md): every reason the wiki is not fit to read
- [Reading budgets](checks/budgets/index.md): how long a page may be
- [Citations](checks/citations/index.md): every statement traced to its source
- [Headings](checks/headings/index.md): labels, not questions
- [Pictures](checks/pictures/index.md): a picture of something that still exists
- [Pointing words](checks/pointing/index.md): names and sentences that point instead of naming

## Reference

- [Commands](commands/index.md): everything wiki does, and how to ask for it
- [wiki audit](commands/audit/index.md): record that pages were checked against the code
- [wiki bless](commands/bless/index.md): record that a picture is still true
- [wiki build](commands/build/index.md): render the pages into the site
- [wiki check](commands/check/index.md): every reason the wiki is not fit to read
- [wiki publish](commands/publish/index.md): build the site for a host
- [wiki serve](commands/serve/index.md): build the site and read it in a browser
- [wiki sync](commands/sync/index.md): bring the skill and the recorded release up to date
- [wiki user](commands/user/index.md): build the pages marked for users
- [wiki.toml](wiki-toml/index.md): the settings file for a wiki
- [Front matter](front-matter/index.md): the settings at the top of every page
- [Infobox fields](front-matter/infobox/index.md): the settings for a page's infobox
- [PICTURES.toml](pictures-toml/index.md): the record of what each picture shows

## Agent prompts

- [Installation prompt](installation-prompt/index.md): a prompt that has an agent install wiki-builder in a project
- [Review prompt](review-prompt/index.md): a prompt that has an agent check a wiki against its project