NVIDIA DocsFab Documentation

Dev

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.

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.

Skip Ahead

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

Support Matrix

Check platform coverage, tested model routes, and environment prerequisites in the DocsFab Support Matrix.

Get Started

Install DocsFab, then follow the Live Agent Quickstart or Runner Quickstart.

Examples

Choose a named job and inspect command examples in Run a Documentation Workflow.

Troubleshooting

Match an error or failed task to a recovery action in Troubleshooting DocsFab.

Use Cases

Choose the documentation outcome you need. Use Cases explains the participating roles and catalog jobs for these goals.

Stand Up Documentation

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.

Keep Documentation Current

Assess documentation impact and propose a scoped update beside a product change. Start with Update Documentation Beside a Change or Review Merge Request Impact.

Trust and Improve the Set

Review an existing set, establish a health baseline, and identify gaps in accuracy or reader evidence. Start with Baseline Documentation Health.

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.

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.

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.

Product Reference Model

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.

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.

Core Components

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

Knowledge

Registers attributed sources, reconciles conflicts, and versions the product reference model. Refer to Product Knowledge.

Runtime

Binds jobs to pinned inputs and allowed tools, executes workflow steps, and retains the result. Refer to Architecture Overview.

Quality

Supplies locked writing, review, evaluation, and deterministic-check inputs to a job. Refer to Documentation Quality.

Host Delivery

Posts review notes or opens draft merge requests through separately authorized GitLab delivery. Refer to GitLab Delivery.

For component relationships, refer to Architecture Overview. For credential, command, and evidence boundaries, refer to Security and Trust.