# 📖 Daily Documentation Updater

> For an overview of all available workflows, see the [main README](../README.md).

**Automatically review and update documentation based on recent code changes and merged pull requests**

The [Daily Documentation Updater workflow](../workflows/doc-updater.md?plain=1) scans changes from the last 24 hours, identifies documentation gaps, and creates pull requests with updates to reflect new features, modifications, or deprecations.

## Installation

```bash
# Install the 'gh aw' extension
gh extension install github/gh-aw

# Add the workflow to your repository
gh aw add-wizard githubnext/agentics/doc-updater
```

This walks you through adding the workflow to your repository.

## How It Works

```mermaid
graph LR
    A[Scan Recent PRs] --> B[Find Code Changes]
    B --> C[Identify Doc Gaps]
    C --> D{Updates Needed?}
    D -->|Yes| E[Update Documentation]
    E --> F[Create PR]
    D -->|No| G[Report: Docs Current]
```

The workflow follows your repository's existing documentation structure and style.

For scheduled runs, the workflow is skipped if there are already 8 or more open PRs with its title prefix, to avoid overwhelming maintainers.

## Usage

### Configuration

This workflow requires no configuration and works out of the box. You can customize the time range, change types to document, and PR settings.

After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.

### Commands

You can start a run of this workflow immediately by running:

```bash
gh aw run doc-updater
```

### Triggering CI on Pull Requests

To automatically trigger CI checks on PRs created by this workflow, configure an additional repository secret `GH_AW_CI_TRIGGER_TOKEN`. See the [triggering CI documentation](https://github.github.com/gh-aw/reference/triggering-ci/) for setup instructions.