Update documentation from the Space Overview
Update documentation compares a Space with its connected Git branch and proposes changes for you to review. Use it for a one-time refresh when you don't use Autopilot, or between Autopilot events. Nothing changes in the Space until you apply a change.
Check whether the documentation is behind
The Documentation ready card on the Space Overview shows the documentation's status against its branch: up to date, how many commits it is behind, which pages may be outdated and which new files no page covers. DocuWriter checks the branch regularly and when you open the Overview; Check now checks again. The check does not use credits.
Run an update
- Open the Space Overview and select Update documentation.
- Review the repository, branch and the cost shown in the dialog.
- For the first update of a Space, choose whether to review all pages or only some.
- Select Update documentation to start. You can leave the page; the update continues and the card shows its progress.
The first update reviews every selected page against the latest code. Later updates check only what changed since the last reviewed commit, and only the pages that change affects.
A review of only some pages does not record a new reviewed commit, so the next update checks all pages again.
Review the proposed changes
When the update finishes, select Review changes. Each change shows the page, why it changes, and a diff or preview.
- Apply saves the change to the page. Reject keeps the page as it is.
- Apply all and Reject all decide every pending change at once.
- If a page changed after the review, its change cannot be applied. Run a new update to refresh it.
- DocuWriter saves a restore point of the Space before the first change of an update is applied.
The update may also suggest new pages for code that no page covers. Choose which ones to write; they then appear as changes to review.
When every change is applied or rejected, the Space is recorded as reviewed through that commit.
Credits
- Reviewing is charged from the AI work the review actually does, up to the maximum shown before you start. Most updates use less than the maximum.
- Each new page you choose to write uses one credit.
- Applying or rejecting changes is free.
If credits run out during an update, it pauses and keeps finished work. Add credits, then select Continue update.
Requirements
- A paid plan and permission to manage the Space.
- A Space connected to GitHub, GitLab, Bitbucket or Azure DevOps. A one-time ZIP cannot be updated from Git.
- The update uses the Space's connected branch. To use another branch, change the Space's source.
Update documentation is separate from Autopilot, which keeps documentation current automatically as code changes. You don't need to enable Autopilot to run an update.