ACE - Docs 

Keep documentation current by tracking freshness, detecting drift, and generating actionable updates.
ACE Logo 

<a href="https://rubygems.org/gems/ace-docs"><img alt="Gem Version" src="https://img.shields.io/gem/v/ace-docs.svg" /></a>
<a href="https://www.ruby-lang.org"><img alt="Ruby" src="https://img.shields.io/badge/Ruby-3.2+-CC342D?logo=ruby" /></a>
<a href="https://opensource.org/licenses/MIT"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-blue.svg" /></a>

Works with: Claude Code, Codex CLI, OpenCode, Gemini CLI, pi-agent, and more.

Getting Started | Usage Guide | Handbook - Skills, Agents, Templates

ace-docs demo

ace-docs provides a practical maintenance loop for teams that need package docs to stay aligned with fast-moving code and workflow changes. It uses frontmatter-based freshness tracking, targeted change analysis, and LLM-assisted update guidance to keep documentation in sync.

How It Works

  1. Track freshness — ace-docs status scans markdown files for frontmatter metadata and reports which documents are current, stale, or outdated based on git history.
  2. Analyze drift — ace-docs analyze FILE compares a document against code changes since its last update and produces LLM-assisted revision guidance.
  3. Validate consistency — ace-docs analyze-consistency checks terminology, duplicates, and version mismatches across a documentation set before release.

Use Cases

Prioritize documentation updates based on real drift - identify which files are stale, what changed since last update, and where to focus first using ace-docs freshness tracking.

Generate targeted update guidance for specific documents - run LLM-assisted analysis with ace-bundle and ace-llm context to propose concrete doc revisions.

Catch cross-document inconsistencies before release - validate metadata and compare documents to find conflicts across package documentation sets before publishing.

Enforce docs quality in release loops - pair with ace-lint for markdown checks and use ace-docs update workflows to keep guides, READMEs, and references in sync.

For concrete analyze/update entry points and deterministic CLI examples, see the Usage Guide and the analyze-and-update workflow examples.

Testing Contract

Run deterministic package coverage with:

ace-test ace-docs
ace-test ace-docs all

Run deterministic feature coverage:

ace-test ace-docs feat

Run retained workflow scenarios in E2E:

ace-test-e2e ace-docs

Getting Started | Usage Guide | Handbook - Skills, Agents, Templates | Part of ACE