> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/docsfab/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/docsfab/_mcp/server.

# NVIDIA DocsFab Documentation

> Create, update, and review documentation from product evidence, then inspect the claims, changes, and quality results behind each outcome.

<span id="overview-of-docsfab"></span>
<span id="benefits"></span>
<span id="the-challenge"></span>
<span id="our-approach"></span>

DocsFab helps product teams create, update, and review documentation from
repository evidence and attributed product knowledge. You can use a local
conversation or a named workflow to produce documentation changes and inspect
their supporting evidence. For capabilities and evidence states, refer to
[Key Features](/docsfab/about/key-features).

<Note title="Current Product Scope">
DocsFab is in project stage alpha. The local command-line interface (CLI)
and live agent are the current product surfaces. Automatic GitLab CI proposals
remain intended, with integration pending. For capability evidence and public
release limitations, refer to
[DocsFab Implementation Status](/docsfab/reference/status-and-configuration/implementation-status).
</Note>

<span id="navigating-this-documentation"></span>
<span id="next-steps"></span>
<span id="learn-more"></span>
<span id="usage-modes"></span>

## Skip Ahead

Choose a starting point for supported environments, your first task, workflow
examples, or recovery.

<CardGroup cols={2}>
  <Card title="Support Matrix" href="/reference/support-matrix">
    Check platform coverage, tested model routes, and environment prerequisites in the
    [DocsFab Support Matrix](/docsfab/reference/support-matrix).
  </Card>
  <Card title="Get Started" href="/get-started/installation">
    [Install DocsFab](/docsfab/get-started/installation), then follow the
    [Live Agent Quickstart](/docsfab/get-started/live-agent-quickstart) or
    [Runner Quickstart](/docsfab/get-started/runner-quickstart).
  </Card>
  <Card title="Examples" href="/workflows/run-a-documentation-workflow">
    Choose a named job and inspect command examples in
    [Run a Documentation Workflow](/docsfab/workflows/run-a-documentation-workflow).
  </Card>
  <Card title="Troubleshooting" href="/troubleshooting">
    Match an error or failed task to a recovery action in
    [Troubleshooting DocsFab](/docsfab/troubleshooting).
  </Card>
</CardGroup>

<span id="user-journeys"></span>

## Use Cases

Choose the documentation outcome you need. [Use Cases](/docsfab/about/use-cases) explains
the participating roles and catalog jobs for these goals.

<CardGroup cols={2}>
  <Card title="Stand Up Documentation" href="/get-started/runner-quickstart">
    <span id="stand-up-documentation"></span>

    Turn product evidence into a new page or short documentation set. Gather
    missing product knowledge before drafting, then inspect the result with
    the [Runner Quickstart](/docsfab/get-started/runner-quickstart).
  </Card>
  <Card title="Keep Documentation Current" href="/workflows/update-documentation-beside-a-change">
    <span id="keep-documentation-current"></span>

    Assess documentation impact and propose a scoped update beside a product
    change. Start with
    [Update Documentation Beside a Change](/docsfab/workflows/update-documentation-beside-a-change)
    or [Review Merge Request Impact](/docsfab/workflows/review-merge-request-impact).
  </Card>
  <Card title="Trust and Improve the Set" href="/workflows/baseline-documentation-health">
    <span id="trust-and-improve-the-set"></span>

    Review an existing set, establish a health baseline, and identify gaps in
    accuracy or reader evidence. Start with
    [Baseline Documentation Health](/docsfab/workflows/baseline-documentation-health).
  </Card>
</CardGroup>

## Core Concepts

These concepts explain how DocsFab turns a request into evidence you can
inspect. Start with jobs and stops to understand execution, then read product
knowledge and quality to interpret the evidence.

<CardGroup cols={2}>
  <Card title="Documentation Jobs" href="/about/core-concepts/documentation-jobs">
    A job binds one named outcome to a repository revision, workflow, and
    allowed operations. It retains a run record, findings, and any authorized
    patch. Refer to
    [Documentation Jobs](/docsfab/about/core-concepts/documentation-jobs).
  </Card>
  <Card title="Job Stops" href="/about/core-concepts/job-stops">
    A stop records why a job cannot finish and what can unblock it. Missing
    input, a failed check, and a capability boundary require different next
    actions. Refer to [When a Job Stops](/docsfab/about/core-concepts/job-stops).
  </Card>
  <Card title="Product Reference Model" href="/about/core-concepts/product-knowledge">
    The product reference model is a canonical, versioned representation of
    shared product understanding. Claims remain traceable to sources, scope,
    decisions, and unresolved questions. Refer to
    [Product Knowledge](/docsfab/about/core-concepts/product-knowledge).
  </Card>
  <Card title="Documentation Quality" href="/about/core-concepts/documentation-quality">
    Quality combines evidence about factual trust, reader understanding, and
    task success. Separate checks retain their own conclusions; a completed
    workflow does not grant publication approval. Refer to
    [Documentation Quality](/docsfab/about/core-concepts/documentation-quality).
  </Card>
</CardGroup>

## Core Components

DocsFab combines knowledge and quality inputs with a runtime that executes
jobs. A separate host channel delivers results to GitLab.

<CardGroup cols={2}>
  <Card title="Knowledge" href="/about/core-concepts/product-knowledge">
    Registers attributed sources, reconciles conflicts, and versions the
    product reference model. Refer to
    [Product Knowledge](/docsfab/about/core-concepts/product-knowledge).
  </Card>
  <Card title="Runtime" href="/about/architecture">
    Binds jobs to pinned inputs and allowed tools, executes workflow steps,
    and retains the result. Refer to
    [Architecture Overview](/docsfab/about/architecture).
  </Card>
  <Card title="Quality" href="/about/core-concepts/documentation-quality">
    Supplies locked writing, review, evaluation, and deterministic-check
    inputs to a job. Refer to
    [Documentation Quality](/docsfab/about/core-concepts/documentation-quality).
  </Card>
  <Card title="Host Delivery" href="/reference/architecture#gitlab">
    Posts review notes or opens draft merge requests through separately
    authorized GitLab delivery. Refer to
    [GitLab Delivery](/docsfab/reference/architecture#gitlab).
  </Card>
</CardGroup>

For component relationships, refer to [Architecture Overview](/docsfab/about/architecture).
For credential, command, and evidence boundaries, refer to
[Security and Trust](/docsfab/about/core-concepts/security-and-trust).