Documentation

Setup, configuration, and behavior for Docs Coverage Bot.

Quick start

Install the GitHub App on the repositories you want to scan.
Open or update a pull request that changes supported source files.
Review the documentation-coverage check run and PR comment.

What the bot checks

Docs Coverage Bot scans changed files in a pull request and reports public symbols that are missing documentation. It currently supports Python, JavaScript/TypeScript, Java, Go, Rust, Elixir, Clojure, Julia, and Common Lisp.

Configuration

Add a .dcbot.yml file in the repository root to change the coverage threshold, include and exclude patterns, auto-fix behavior, and documentation style conventions.

threshold: 90
auto_fix: true
max_suggestions: 25

include:
  - src/**

exclude:
  - vendor/**
  - "**/*_test.py"

conventions:
  python:
    style: numpy

More detail

For configuration help, bug reports, and feature requests, use the public support resources.

Go to support