--- title: "DocsFab" publisher: "nvidia" type: "blueprint" updated: "2026-10-22T20:29:11.325Z" description: "DocsFab is a documentation agent that reviews, creates, and updates product docs from your source repo, with built-in quality checks." canonical: "https://build.nvidia.com/nvidia/docsfab" --- DocsFab helps product and documentation teams turn repository evidence into clear, reviewable product documentation. It can create a first set of docs, update pages affected by a change, review an existing set, or plan a focused restructure. It gathers evidence from the selected source revision and asks when important product intent is missing or sources disagree. DocsFab is in early access and runs locally through the `docsfab` command-line tool. Connect a model through an OpenAI-compatible or Anthropic-compatible endpoint, including a hosted or self-hosted NVIDIA NIM. ## Start with a Review After installing and configuring DocsFab, open a repository and start an inspection-only conversation: ```bash cd /path/to/your-repository docsfab live-agent --read-only ``` Then ask: “Review the getting-started docs for clarity and tell me what to improve.” The live agent can answer questions and help with focused edits. In read-only mode it cannot edit files, run write workflows, or run host commands; it can run read-only review workflows. In a normal session, edits are enabled and each host command requires approval in the terminal. ## Documentation Jobs For repeatable work, run a named documentation job: - `review-documentation` reviews a set of existing pages. - `create-documentation` drafts new pages from selected source material. - `update-documentation` proposes changes for pages affected by a change. - `restructure-documentation` plans and proposes a bounded reorganization. Jobs use selected repository files at a pinned revision. Create and update jobs can also use explicitly bound evidence such as PDF or DOCX files and merge-request or change evidence; supported inputs vary by job. Optional product knowledge can add context when available. Built-in quality checks report their findings separately; their results are not a single universal pass or guarantee. A direct live-agent answer or edit does not by itself run the full job checks or create a workflow run record. Write jobs can keep a patch for local review or open a draft GitLab merge request. A person reviews and merges the change; delivery is a separate authorized step. Direct live-agent host commands require approval in the terminal. Credentials stay with host-controlled adapters and are not placed in model prompts. ## Architecture Diagram ![DocsFab architecture diagram](https://assets.ngc.nvidia.com/products/api-catalog/docsfab/diagram.jpg) ## Minimum System Requirements - No GPU is required to run DocsFab; the model runs at the endpoint you connect. Follow the connected NVIDIA NIM's hardware requirements if you self-host a NIM. - macOS or Linux, or Windows 11 with WSL2. Native Windows is not supported. - Node.js 24.21.0 or later, Git, and npm. - An API key and model ID for an OpenAI, Anthropic, or compatible endpoint to run model-backed workflows. The model must support streaming and native tool calling. - Linux with Bubblewrap and working unprivileged user namespaces for repository validation checks that require isolated command execution. Other supported platforms can run setup and model-backed workflows. - Authenticated `glab` and permission to push a branch for workflows that open a draft GitLab merge request. Read-only reviews and patch-only runs do not need GitLab push access. ## Software Used in This Developer Example **NVIDIA technology** - NVIDIA NIM microservices (optional): connect a hosted or self-hosted NIM through the OpenAI-compatible provider. **Third-party software** - [Node.js](https://nodejs.org/) - [Git](https://git-scm.com/) - [GitLab CLI](https://gitlab.com/gitlab-org/cli) (`glab`), for draft merge request delivery ## Ethical Considerations NVIDIA believes Trustworthy AI is a shared responsibility, and we have established policies and practices to enable development for a wide array of AI applications. When downloaded or used in accordance with our terms of service, developers should work with their supporting model team to ensure the models meet requirements for the relevant industry and use case and address unforeseen product misuse. For more detailed information on ethical considerations for the models, please see the Model Card++ Explainability, Bias, Safety & Security, and Privacy Subcards. Please report security vulnerabilities or NVIDIA AI concerns [here](https://www.nvidia.com/en-us/support/submit-security-vulnerability/). ## License DocsFab source code is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). Included skill instructions and documentation are licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/), and skill scripts are licensed under Apache-2.0. The designated NVIDIA Technical Documentation Style Baseline files are also under CC-BY-4.0. See the repository’s `LICENSE` and `NOTICE` files for scope and attribution. Models and endpoints connected to DocsFab are governed by their own terms. ## Get Started Public installation instructions will be available through the [GitHub repository](https://github.com/NVIDIA-AI-Blueprints/docsfab) when the release is available. If you already have an early-access installation, configure a model endpoint with `docsfab setup`, check your setup with `docsfab doctor`, and start with the read-only review above.