Skip to content
Big PlanBig Plan is in alpha

Sample plans

The fastest way to understand Big Plan is to read one. These are real documents, rendered by the current CLI from plans that live in the repository — not screenshots, and not mockups.

Open one and try it: the section navigation, the collapse controls, the copy and maximize buttons on code and tables. Everything except commenting works in a standalone document, because commenting needs a live review behind it.

The rate limiting plan open in the Big Plan viewerThe rate limiting plan open in the Big Plan viewerRate limiting for a public API

A short, ordinary plan, and the size a real one usually is. Look for the quick summary that opens it, the comparison table under Options considered, and the code diff with its line-anchored annotation. Start here.

The payments retry queue plan, structured as a deck of numbered actsThe payments retry queue plan, structured as a deck of numbered actsA payments retry queue

The same shape, organised as a deck. Look for the numbered act bands, the kicker above each slide title, and how the table of contents groups its rows under those acts by itself.

The workflow builder plan, showing a wireframe prototype of eleven screensThe workflow builder plan, showing a wireframe prototype of eleven screensA workflow builder surface

A plan about an interface, so it shows the interface. Eleven true-size screens you can click through, with a switcher above each wireframe and a maximize control on it.

A plan that renders every Big Plan component in one documentA plan that renders every Big Plan component in one documentEvery component at once

Not a plan you would write — a gallery. Look for the sortable data table, the database schema, the three API contract cards, and the decision matrix with its score calculation.

Where these come from

Section titled “Where these come from”

Each sample is one MDX file rendered with big-plan render, which produces a single self-contained HTML document: embedded styles, fonts, and images, no external requests, and a complete reading experience with JavaScript disabled.

_docs/scripts/gen-samples.mjs renders them from the repository’s own examples every time this site is built, so a sample can never show a document the current CLI would not produce.

Sample Rendered from Markdown source
Rate limiting for a public API _docs/src/demo/example-plan.md plan.md
A payments retry queue examples/deck.mdx plan.md
A workflow builder surface examples/workflow-engine-builder.mdx plan.md
Every component at once examples/all-components.mdx plan.md

Next

Section titled “Next”

Components — what each of the pieces in those documents is for.