Documentation

This site is the documentation for Pagedeck, and it is built with Pagedeck. Every page you are reading was a markdown file on disk a moment before it was HTML: a loader read it, a schema checked what it declared, and one template rendered it. No page on this site loads any JavaScript.

How the documentation is organised

The four sections follow Diátaxis, which sorts documentation by what a reader is trying to do rather than by which part of the software it is about.

• Tutorials are for learning. They take you through building something small, end to end, and they assume you have not used Pagedeck before.
• How-to guides are for a task you already have. They answer "how do I do X" and assume you know what X is.
• Reference describes what exists: the commands, the contracts, the exit codes. It is written to be looked things up in, not read through.
• Explanation is the reasoning. Why Pagedeck works the way it does, and what was decided against.

The navigation on every page lists every document in all four, under a fifth group — Overview — that holds this page. Diátaxis has nothing to say about a front page, and every site has one.

What is here today

Pagedeck is early, and this site says so rather than implying otherwise. Two kinds of document are published here:

• Pages written for this site, which are the tutorials, how-to guides and reference below.
• Some of the repository's own working documents — the architecture decision records, the error-message standard and the deploy recipe. They were written for the people building Pagedeck, and they read that way. They are published because they are the most accurate description of the system that exists.