🪄Generating docs

A run goes in three steps, and the progress dialog shows each one as it happens.

1. Read. DocSpell builds a map of the repo from the paths you picked.
2. Plan. It decides which pages the docs need, what each covers, how they nest, and which source files each one is written from.
3. Write. Each page is written from its own files, then saved. The dialog lists pages as they land, so you can open the first one while the rest are still being written.

When it's done#

Generated pages are drafts. Nobody sees them until you publish. The dialog sends you to the doc space overview, where Needs you lists every draft and Publish all puts them live in one go. Prefer to read first? Open each page, edit it, and publish it from the editor instead.

Starting over#

A run adds pages to the doc space. To replace everything, turn on the option in the generation dialog that deletes the existing pages first. The dialog warns you before anything is deleted.

Limits#

Each plan includes a number of generations, shown in the dialog and on your billing page before you start. Runs that fail don't count. Current numbers are in the pricing table.