# Update Docs From Commits

Scan recent git commits for changes that affect user-facing behavior, then draft or...

- Repository: https://github.com/NVIDIA/OpenShell (20903 stars)
- Category: Git and review
- License: Apache-2.0
- Last updated: 2026-11-01
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add NVIDIA/OpenShell --skill update-docs-from-commits -g -a claude-code -y`
Codex: `npx skills add NVIDIA/OpenShell --skill update-docs-from-commits -g -a codex -y`
Cursor: `npx skills add NVIDIA/OpenShell --skill update-docs-from-commits -g -a cursor -y`
Gemini CLI: `npx skills add NVIDIA/OpenShell --skill update-docs-from-commits -g -a gemini-cli -y`

## Description

Scan recent git commits for changes that affect user-facing behavior, then draft or update the corresponding documentation pages. Use when docs have fallen behind code changes, after a batch of features lands, or when preparing a release. Trigger keywords - update docs, draft docs, docs from commits, sync docs, catch up docs, doc debt, docs behind, docs drift.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# Update Docs from Commits

Scan recent git history for commits that affect user-facing behavior and draft documentation updates for each.

## Prerequisites

- You must be in the OpenShell git repository.
- The published docs tree must exist under `docs/`.
- Read `docs/CONTRIBUTING.mdx` before writing any content. It contains the current style guide and formatting rules.

## When to Use

- After a batch of features or fixes has landed and docs may be stale.
- Before a release, to catch any doc gaps.
- When a contributor asks "what docs need updating?"

## Step 1: Identify Relevant Commits

Determine the commit range. The user may provide one explicitly (e.g., "since v0.2.0" or "last 30 commits"). If not, default to commits since the head of the main branch.

```bash
# Commits since a tag
git log v0.2.0..HEAD --oneline --no-merges

# Or last 50 commits
git log -50 --oneline --no-merges
```

Filter to commits that are likely to affect docs. Look for these signals:

1. **Commit type**: `feat`, `fix`, `refactor`, `perf` commits often change behavior. `docs` commits are already doc changes. `chore`, `ci`, `test` commits rarely need doc updates.
2. **Files changed**: Changes to `crates/openshell-cli/`, `python/`, `proto/`, `deploy/`, gateway config parsing, driver config structs, or policy-related code are high-signal.
3. **Ignore**: Changes limited to `tests/`, `e2e/`, `.github/`, `tasks/`, or internal-only modules.

```bash
# Show files changed per commit to assess impact
git log v0.2.0..HEAD --oneline --no-merges --name-only
```

## Step 2: Map Commits to Doc Pages

For each relevant commit, determine which doc page(s) it affects. Use this mapping as a starting point:

The rest: https://github.com/NVIDIA/OpenShell/blob/HEAD/.agents/skills/update-docs/SKILL.md