Skip to main content
ZAR detects a stale README after a config change, opens docs PR #43 with the minimal edit, and the zar/docs check turns green
ZAR is a GitHub App that keeps your documentation accurate as the code changes. It reads your pull requests the way a reviewer would, then proposes the smallest Markdown edit that makes the docs true again, as a PR you review and merge.

​
What is ZAR?

Pull requests change APIs, flags, and flows, and the README and docs/ quietly fall behind. ZAR closes that gap. Powered by Claude and tree-sitter, it watches your repository, notices when a change made the docs inaccurate, and proposes a minimal, grounded fix. It never invents facts, never commits without explicit opt-in, and ships nothing in dry-run mode.

​
Get Started

Quick start

Install the GitHub App at app.zarlabs.tech, then open a pull request that changes real behavior. ZAR reviews the diff and proposes the doc fix. You can also drive it from any PR comment with @docagent update docs now.

Quickstart

From install to your first documentation suggestion in about five minutes.

Installation

Install the GitHub App, the permissions it needs, and first-install onboarding.

How it works

The full pipeline from webhook to docs PR, and every gate in between.

CI gate

Block a merge when the docs look stale, the same way a failing test blocks one.

Commands

Drive ZAR from a PR comment: set a style, toggle features, force a run.

MDX & multilingual

Nextra-style .mdx and multilingual docs, with frontmatter kept intact.

Reference

Settings, commands, env vars, permissions.

Troubleshooting

Symptom-to-fix for common issues.

Plans

Tiers, limits, and how access works.

Dashboard

Manage your repos and watch every run.