Runs
Follow how Docup writes and updates your docs, retry failed pages, and read the history of every run.
A run is one job Docup does for your project. The Runs section lists them all, newest first, and each one has a page of its own.
Kinds of runs#
| Kind | What it does |
|---|---|
| Sync | The first run. Reads the repository, plans the docs and writes every page. |
| Page retry | Writes one failed page again. |
| Update | Brings pages up to date after a push to your default branch. |
Statuses#
A run is Queued, Running, Succeeded, Partial, or Failed. A sync that finished with some failed pages shows as Partial: the pages that worked are saved, and the failed ones wait for a retry.
Read a sync run#
A sync run shows:
- Source: the branch and the commit that was read, linked to GitHub.
- Duration: when it started and how long it took.
- Files read: how many files were given to the AI, and how many the filter kept away from it.
- Steps: Read the repository, Plan the docs, Write each page, Save the draft. While the run is live, the current step is highlighted and pages move from pending to writing to done as they finish. Leaving the tab is fine; the view reconnects when you come back.
- Pages: a table with each page, the files it was Written from, and its result.
Retry a failed page#
A page fails when Docup cannot produce a usable version after several attempts. From the run, or from the page, choose Retry.
- A retry is a run of its own and takes a minute or two.
- A workspace can retry up to 50 pages per day.
- If you would rather write the page yourself, open it and type. Once it has text, it is a normal page.
If an entire first run fails, for example because the repository has no readable files or GitHub could not be reached, the run shows the reason and Try again starts a new one. Retrying a first run counts toward the 10 runs per day each workspace can start.
Read an update run#
An update run shows the commit, the previous commit it follows, a link to view the commit on GitHub, and what happened to each page. The summary line reads like "Published 2 pages, 1 update to review". The meaning of each result is in Keeping docs up to date.
While an update run is live, the view displays its current step—such as "Reading what changed", "Deciding what the docs need", or "Updating the pages"—and automatically refreshes every few seconds. If the update fails, a "This update failed" alert shows the error message.
Runs never change your repository, and a failed run never changes the text of existing pages.