> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.nvidia.com/docsfab/workflows/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/docsfab/_mcp/server. # Workflows ## Docs - [Run a Documentation Workflow in DocsFab](https://docs.nvidia.com/docsfab/workflows/run-a-documentation-workflow.md): Run one named DocsFab workflow against an immutable repository revision and inspect its saved result. For a persistent conversation, use the Live Agent Quickstart. - [Create a Documentation Set in DocsFab](https://docs.nvidia.com/docsfab/workflows/create-documentation-set.md): Create a new source-grounded page or coordinated page set and inspect the resulting documentation patch. - [Update Documentation Beside a Change in DocsFab](https://docs.nvidia.com/docsfab/workflows/update-documentation-beside-a-change.md): Run a bounded documentation update against an approved product change. - [Update a Documentation Set in DocsFab](https://docs.nvidia.com/docsfab/workflows/update-documentation-set.md): Request coordinated changes across existing pages and inspect the page-set and navigation evidence. - [Update One RST Page in DocsFab](https://docs.nvidia.com/docsfab/workflows/update-rst-page.md): Update top-level prose in one existing tracked reStructuredText page through the local patch path. - [Verify That Documentation Needs No Change in DocsFab](https://docs.nvidia.com/docsfab/workflows/verify-no-change.md): Bind current documentation and comparison evidence so an update job can establish a verified no-change result. - [Restructure a Documentation Set in DocsFab](https://docs.nvidia.com/docsfab/workflows/restructure-documentation-set.md): Reorganize existing documentation while preserving its content, routes, anchors, and reader entry points. - [Assess Documentation Readiness in DocsFab](https://docs.nvidia.com/docsfab/workflows/assess-readiness.md): Run a source-readiness or release-documentation assessment and inspect its scope-bound disposition. - [Audit Pages Against Templates in DocsFab](https://docs.nvidia.com/docsfab/workflows/audit-templates.md): Run the deterministic template-conformance audit without a model call. - [Baseline Documentation Health in DocsFab](https://docs.nvidia.com/docsfab/workflows/baseline-documentation-health.md): Run the multi-lens review-documentation job as a documentation-set baseline. - [Review Merge Request Impact in DocsFab](https://docs.nvidia.com/docsfab/workflows/review-merge-request-impact.md): Run a local review or configure hosted automatic review notes on merge requests. - [Investigate Saved Runs in DocsFab](https://docs.nvidia.com/docsfab/workflows/investigate-saved-runs.md): Query saved DocsFab runs to identify recurring failure signatures, inspect supporting evidence, and choose a bounded next action. - [Select Source Evidence in DocsFab](https://docs.nvidia.com/docsfab/workflows/select-sources.md): Preview the source files and merge-request evidence an invocation binds before running a documentation job. - [First-Pass Knowledge in DocsFab](https://docs.nvidia.com/docsfab/workflows/first-pass-knowledge.md): Understand which evidence a create or update job gathers before planning and why an unresolved obligation can stop it. - [Bind a Local Commit Range in DocsFab](https://docs.nvidia.com/docsfab/workflows/bind-commit-range.md): Ground a create or update job on an explicit local Git commit range. - [Bind a GitLab Change in DocsFab](https://docs.nvidia.com/docsfab/workflows/bind-gitlab-change.md): Ground a create or update job on one GitLab merge request and its immutable diff. - [Bind a GitHub Change in DocsFab](https://docs.nvidia.com/docsfab/workflows/bind-github-change.md): Ground a create or update job on one GitHub pull request, commit, or compare selection. - [Bind a Release Range in DocsFab](https://docs.nvidia.com/docsfab/workflows/bind-release-range.md): Ground a documentation job on the named tags, commits, and changelog evidence of a release range. - [Attach Evidence to a Live Session in DocsFab](https://docs.nvidia.com/docsfab/workflows/attach-live-sources.md): Bind tracked files or one merged GitLab merge request as immutable evidence for a live session. - [Edit Documentation in the DocsFab Live Agent](https://docs.nvidia.com/docsfab/workflows/edit-in-live-agent.md): Request documentation edits and approve scoped host commands in an attached terminal conversation. - [Deliver a Live-Agent Patch in DocsFab](https://docs.nvidia.com/docsfab/workflows/deliver-live-patch.md): Inspect a saved workflow patch and choose checkout application or draft merge-request delivery. - [Supply Requested Work Products in DocsFab](https://docs.nvidia.com/docsfab/workflows/supply-work-products.md): Fill named file or text inputs for the exact editorial job that stopped with needs-input. - [Answer and Resume a Stopped Job in DocsFab](https://docs.nvidia.com/docsfab/workflows/answer-and-resume.md): Resume the original create or update job after an accountable participant supplies an attributed snapshot for its durable knowledge stop. For an editorial request for named files or text, follow Supply Requested Work Products. - [Review Documentation From Slack in DocsFab](https://docs.nvidia.com/docsfab/workflows/review-from-slack.md): Start a focused documentation or merge-request review from the project's connected Slack channel. - [Ask a Documentation Question From Slack in DocsFab](https://docs.nvidia.com/docsfab/workflows/ask-from-slack.md): Ask one read-only question against a connected project's tracked documentation. - [Continue a Hosted Documentation Review in DocsFab](https://docs.nvidia.com/docsfab/workflows/continue-hosted-review.md): Continue the retained remainder of a partial hosted review at the same immutable revision. - [Run the Knowledge-Gathering Workflow in DocsFab](https://docs.nvidia.com/docsfab/workflows/run-knowledge-gathering-workflow.md): Gather evidence, resolve model gaps, synthesize source threads, and assess documentation readiness. - [Conduct a Product-Model Interview in DocsFab](https://docs.nvidia.com/docsfab/workflows/conduct-product-model-interview.md): Conduct a bounded, consent-aware interview that captures missing intent and tests an emerging product model. - [Reconcile Source Threads in DocsFab](https://docs.nvidia.com/docsfab/workflows/reconcile-source-threads.md): Compare a bounded set of source threads, adjudicate inconsistencies, issue a new model version, and converge the documentation set. - [Run DocsFab in CI](https://docs.nvidia.com/docsfab/workflows/run-docsfab-in-ci.md): Provision credentials, bind an installed composition, stage evidence, and assess documentation impact after each merge in a DocsFab job that runs unattended in a CI/CD pipeline. - [Run a Live-Agent Task Noninteractively](https://docs.nvidia.com/docsfab/workflows/run-live-agent-noninteractively.md) - [Propose Documentation After CI in DocsFab](https://docs.nvidia.com/docsfab/workflows/automatic-ci-proposals.md): Distinguish the intended CI documentation proposal from the local pair you can run today. - [Delegate a Local Task in DocsFab](https://docs.nvidia.com/docsfab/workflows/delegate-a-task.md): Use the explicit delegated pilot for one finite local documentation task. - [Deliver or Recover a Draft Merge Request in DocsFab](https://docs.nvidia.com/docsfab/workflows/deliver-draft-mr.md): Inspect or recover the exact draft merge-request delivery for a saved documentation result. > **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.nvidia.com/docsfab/workflows/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/docsfab/_mcp/server. # About DocsFab Workflows > Find the DocsFab workflow guide for the documentation or product-knowledge task you need to complete. DocsFab workflows are task guides that you use after setup to run one specific documentation or product-knowledge job. Each workflow keeps product evidence, runtime execution, quality checks, and write authority explicit. For more information, refer to [Overview of DocsFab](/docsfab/about). ## Before You Choose Complete [Install DocsFab](/docsfab/get-started/installation) before you run a workflow. Define one bounded product, repository revision, audience, and documentation target. A workflow can produce evidence, a model artifact, or a reviewable patch. It does not grant publication, deployment, or merge authority. To create the first page or a short set for a new product or feature, start with the [Runner Quickstart](/docsfab/get-started/runner-quickstart). ## Choose a Workflow Choose the task guide for the result you need: | Goal | Guides | | --- | --- | | Create, update, or restructure pages. | [Create a Documentation Set](/docsfab/workflows/create-documentation-set), [Update Beside a Change](/docsfab/workflows/update-documentation-beside-a-change), [Update a Page Set](/docsfab/workflows/update-documentation-set), [Restructure a Set](/docsfab/workflows/restructure-documentation-set) | | Inspect existing documentation. | [Baseline Documentation Health](/docsfab/workflows/baseline-documentation-health), [Review Merge Request Impact](/docsfab/workflows/review-merge-request-impact), [Audit Templates](/docsfab/workflows/audit-templates), [Assess Readiness](/docsfab/workflows/assess-readiness) | | Bind evidence to a job. | [Select Sources](/docsfab/workflows/select-sources), [Bind a Commit Range](/docsfab/workflows/bind-commit-range), [Bind a GitLab Change](/docsfab/workflows/bind-gitlab-change), [Bind a GitHub Change](/docsfab/workflows/bind-github-change), [Bind a Release Range](/docsfab/workflows/bind-release-range) | | Handle a specialized update. | [Update One RST Page](/docsfab/workflows/update-rst-page), [Verify No Change](/docsfab/workflows/verify-no-change) | | Work in a persistent conversation. | [Attach Live Evidence](/docsfab/workflows/attach-live-sources), [Edit Documentation](/docsfab/workflows/edit-in-live-agent), [Deliver a Live-Agent Patch](/docsfab/workflows/deliver-live-patch) | | Continue stopped work. | [Supply Requested Work Products](/docsfab/workflows/supply-work-products), [Answer and Resume](/docsfab/workflows/answer-and-resume) | | Use an activated Slack project. | [Review From Slack](/docsfab/workflows/review-from-slack), [Ask a Documentation Question](/docsfab/workflows/ask-from-slack), [Continue a Hosted Review](/docsfab/workflows/continue-hosted-review) | | Automate or deliver a result. | [Run in CI](/docsfab/workflows/run-docsfab-in-ci), [Automatic CI Proposals](/docsfab/workflows/automatic-ci-proposals), [Delegate a Local Task](/docsfab/workflows/delegate-a-task), [Deliver a Draft MR](/docsfab/workflows/deliver-draft-mr) | | Inspect execution evidence. | [Investigate Saved Runs](/docsfab/workflows/investigate-saved-runs), [Diagnose a Failed Run](/docsfab/manage/diagnose-run) | For the common execution steps, follow [Run a Documentation Workflow](/docsfab/workflows/run-a-documentation-workflow). For first-pass source selection and stops, refer to [First-Pass Knowledge](/docsfab/workflows/first-pass-knowledge). Exact stage order, fields, and authority rules remain in [Workflow Contracts](/docsfab/reference/workflow-contracts). ## Gather Product Knowledge When a documentation job stops because load-bearing product evidence is missing, contradictory, or stale, gather and reconcile that evidence before you resume the documentation work. Product-knowledge work does not replace a version-bound behavior check, an accountable intent decision, or a documentation-quality review. Complete these stages in order when you start without a validated product model: 1. [Run the knowledge-gathering workflow](/docsfab/workflows/run-knowledge-gathering-workflow). 2. [Conduct a product-model interview](/docsfab/workflows/conduct-product-model-interview) when attributable intent or participant knowledge is missing. You can skip the interview when registered evidence already covers the target. 3. [Reconcile source threads](/docsfab/workflows/reconcile-source-threads) and issue the next model version. You cannot skip reconciliation when selected source threads contain unresolved differences that affect the target. Stop and preserve the open dependency when any of the following conditions apply: - The authoritative source or exact version is unavailable. - Retention, citation, access, or participant consent does not cover the proposed artifact. - A conflict requires behavior evidence or an accountable decision that is not available. - Provenance is lost, or an immutable source or model version would need to be overwritten. Do not fill the gap with conversational memory or plausible prose. Keep the affected documentation target blocked until its load-bearing evidence is available. ## Understand the Boundaries The two workflow groups have the following responsibilities: - Product-knowledge workflows establish traceable inputs and readiness. They do not silently promote a participant statement or agent inference into product truth. - Documentation workflows bind pinned inputs to a fixed runtime job and quality policy. They do not broaden write or delivery authority from the wording of a request. For the underlying authority model, refer to [A Result Grants No Authority](/docsfab/about/core-concepts/documentation-jobs#a-result-grants-no-authority). For the intended product goals these journeys serve, refer to [Use Cases](/docsfab/about/use-cases).