Current
Generation Reviews
How generations hold changed pages for review so people keep control of content they wrote or approved
Overview
When Doxabot generates docs for a project that already has published content, the new output does not go live right away. Doxa holds it in a review. You decide on each page, then publish the result. Until you publish, your live site does not change.
This matters because a generation can replace pages that you or a teammate wrote or approved. The review gives you a chance to keep those pages, edit them, or accept the new version.
When a generation goes to review
Whether a generation publishes directly depends on what the site already has live:
| Live site | Result |
|---|---|
| No published version | The generation publishes directly. |
| Only starter content | The generation publishes directly. |
| Any other published content | The generation is staged and a review opens. |
A staged generation is stored as a version that is not live. The Generations page shows it, and the review lets you work through its pages before anything changes on your site.
Warning before the first generation
If your site has pages from the content editor or from an import, and there is no earlier generation to compare against, the dashboard asks you to confirm before it starts. The confirmation dialog explains the review and the backup branch that Doxa keeps for your existing content.
Note:
The first generation on a site with hand-written pages can replace them in the review. Read the review before you publish, and keep the backup branch until you are satisfied with the result.
Deciding on review pages
Work through the pages the generation changed:
Compare the generated page with the published page.
Keep, edit, or replace each page. Your edits on the review branch are kept.
Publish when every page is decided. The live site updates only at that point.
To edit review pages, use the content editor. To learn how branches, previews, and publishing work, see Branches, previews, publishing, and restore.
Renamed and moved pages
You can rename a page in a review, or move it to another section, on the review branch. Doxa keeps track of the page:
The review still matches the page to the location the generation gave it, so the comparison with the published page stays accurate.
Decisions apply to the page where it is now.
The review marks the page at its new location, and you can step through the moved pages from there.
A newer generation while a review is open
If a new generation runs while a review is still open, Doxa moves the open review to the new output:
The review compares the current published version with the new generated version.
A decision you made carries over when the page has the same kind of change.
Changes from the earlier generation that the new run does not repeat go back to the published version.
Your edits stay.
A page you renamed or moved stays where you put it, unless the new run also produces a page at its original location.
The review's base moves to the current published version.
The new run rebuilds the navigation from its own structure. A change you made to the navigation for a page outside the review does not carry over. If a review keeps a backup, the backup is kept after the move.
When merged pull requests start a generation
The Doxabot settings for a project choose what happens when a pull request merges into the default branch. Every resulting generation still goes to a review, so no setting changes your live site by itself.
| Merge trigger | Result |
|---|---|
manual | The merge is listed on the project overview. You start the update yourself. |
batched (default) | One generation starts after no pull request has merged for the quiet period. |
every_merge | A generation starts after each merge. |
The quiet period for batched is 15, 30, 60, or 360 minutes. The default is 30 minutes.
Note:
Only the merge trigger changes when a generation starts. Publishing always happens from the review, so check the review after each run.