> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zarlabs.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Welcome to ZAR

> Keep your repository documentation accurate as the code changes.

<Frame>
  <img src="https://mintcdn.com/zarlabs/wGDdOYoqU66eyDmK/assets/demo.gif?s=eda6d39172296c11e81967d68d64d518" alt="ZAR detects a stale README after a config change, opens docs PR #43 with the minimal edit, and the zar/docs check turns green" width="900" height="540" data-path="assets/demo.gif" />
</Frame>

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

<Card title="Quick start" icon="rocket" href="/quickstart">
  Install the GitHub App at [app.zarlabs.tech](https://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`.
</Card>

<CardGroup cols={2}>
  <Card title="Quickstart" icon="bolt" href="/quickstart">
    From install to your first documentation suggestion in about five minutes.
  </Card>

  <Card title="Installation" icon="github" href="/installation">
    Install the GitHub App, the permissions it needs, and first-install onboarding.
  </Card>

  <Card title="How it works" icon="diagram-project" href="/concepts/how-it-works">
    The full pipeline from webhook to docs PR, and every gate in between.
  </Card>

  <Card title="CI gate" icon="shield-halved" href="/features/ci-gate">
    Block a merge when the docs look stale, the same way a failing test blocks one.
  </Card>

  <Card title="Commands" icon="terminal" href="/features/commands">
    Drive ZAR from a PR comment: set a style, toggle features, force a run.
  </Card>

  <Card title="MDX & multilingual" icon="language" href="/features/mdx-and-multilingual">
    Nextra-style `.mdx` and multilingual docs, with frontmatter kept intact.
  </Card>
</CardGroup>

## Quick Links

<CardGroup cols={4}>
  <Card title="Reference" icon="book" href="/reference/settings">
    Settings, commands, env vars, permissions.
  </Card>

  <Card title="Troubleshooting" icon="wrench" href="/troubleshooting">
    Symptom-to-fix for common issues.
  </Card>

  <Card title="Plans" icon="credit-card" href="/plans">
    Tiers, limits, and how access works.
  </Card>

  <Card title="Dashboard" icon="gauge" href="https://app.zarlabs.tech">
    Manage your repos and watch every run.
  </Card>
</CardGroup>
