Propose Documentation After CI in DocsFab
Live pilot-host auto-draft after customer continuous integration (CI) is not
established. A read-only pipeline observer can freeze a complete C..H
range after a successful default-branch push pipeline. That observer does
not invoke a model, enqueue documentation work, publish, or grant
source-control authority. Refer to
DocsFab Implementation Status.
DocsFab’s intended automatic path is a successful default-branch push
pipeline, then a frozen C..H range from coverage base through that
pipeline head. The next jobs are a bounded update-documentation run and
an independent review-documentation run. Delivery is at most one
immutable draft merge request through a separately authorized publisher.
For more information, refer to
About DocsFab Workflows.
Today you run that update and review pair locally. Mailbox notes on an existing merge request are a different path. Refer to GitLab Host Mailbox in DocsFab.
Before You Start
Complete the steps in Install DocsFab. Prepare the repository revision that the successful pipeline built.
Confirm the following conditions:
- You can run
docsfab doctoranddocsfab listagainst that checkout. - You can describe the user-facing change in an
update-documentationinstruction. - You accept a local patch first. Independent review of an unapplied patch tree is part of the intended automatic path. It is not a local CLI command on this page.
Read Update Documentation Beside a Change in DocsFab and Review Merge Request Impact in DocsFab before you run the pair.
Steps
Freeze the inputs
Freeze the inputs for this documentation job. Use the revision the
successful pipeline built. When you bind reader files, pass
--reader-source on docsfab run update-documentation.
Expected result: You can name the repository path, the revision, and the documentation pages the change can affect. You do not wait for a pipeline observer to enqueue a job.
Run a bounded update
Run a bounded update and keep the result local.
Add --reader-source <role>=<repository-relative-path> when you must bind
current documentation, changed source, or public-contract files. Refer to
Update Documentation Beside a Change in DocsFab
for the supported roles.
Expected result: The run retains a reviewable patch or reports an
evidence-backed limitation. --patch-only does not apply the patch or
open a merge request.
Run an independent review
Run an independent read-only review against the same repository revision. Do not treat the update run as that review.
Pass --revision <ref> when the checkout HEAD is not the revision you
intend to review.
Expected result: The review writes findings and quality evidence without
a write grant. Audience insufficient-evidence remains visible and does
not become a success claim. Refer to
Baseline Documentation Health in DocsFab.
Inspect both run records
Inspect both run records before you consider delivery.
Expected result: The update record and the review record stay separate. A successful update does not imply that independent review passed.
Optional: deliver a draft merge request
After you inspect both results, deliver one draft merge request through the separately authorized publisher path for the succeeded write.
Expected result: Delivery reuses the retained patch without another model call. It cannot merge the result. This local delivery is not live pilot-host auto-draft after customer CI.
Troubleshooting
If the update stops with needs-input, read PRODUCT and the printed NEXT
command. Refer to
A Job Stops With Needs Input After It Starts
or Answer and Resume a Stopped Job in DocsFab for a knowledge
snapshot stop.
If you expected an automatic draft merge request after a default-branch pipeline, that path is not established. Run the local pair on this page. Mailbox notes on an existing merge request remain a different path. Refer to GitLab Host Mailbox in DocsFab.
If doctor reports blocked readiness, follow the printed next command. Refer to Doctor Reports Blocked Readiness.