# ZAR

> ZAR keeps your repository documentation accurate as the code changes. PR-native, powered by Claude + tree-sitter.

## Docs

- [Changelog](https://docs.zarlabs.tech/changelog.md): Notable changes to the ZAR documentation.
- [How ZAR works](https://docs.zarlabs.tech/concepts/how-it-works.md): The full pipeline from a GitHub webhook to a documentation pull request — and the decisions ZAR makes along the way.
- [Safety & guarantees](https://docs.zarlabs.tech/concepts/safety-and-guarantees.md): Exactly what ZAR will and will not do to your repository, and the mechanisms that enforce it.
- [Configuration overview](https://docs.zarlabs.tech/configuration/overview.md): Where ZAR settings live, which ones go in .zar.yml versus the dashboard, and how they combine.
- [Style guide](https://docs.zarlabs.tech/configuration/style-guide.md): Teach ZAR your documentation voice so its edits read like the rest of your docs.
- [Trigger modes](https://docs.zarlabs.tech/configuration/trigger-modes.md): Control when ZAR opens a documentation PR — the four trigger modes, the significance filter, batching, and dry-run.
- [.zar.yml reference](https://docs.zarlabs.tech/configuration/zar-yml.md): The version-controlled ZAR configuration file — every supported key, with types, defaults, and a complete example.
- [FAQ](https://docs.zarlabs.tech/faq.md): Frequently asked questions about ZAR.
- [Auto-commit](https://docs.zarlabs.tech/features/auto-commit.md): Let ZAR commit documentation fixes directly instead of opening a PR — and the two locks that gate it.
- [CI gate](https://docs.zarlabs.tech/features/ci-gate.md): Block a merge when documentation looks stale — how to enable it, what it posts, and how it fails safe.
- [Commands](https://docs.zarlabs.tech/features/commands.md): Drive ZAR from a pull request or issue comment with plain-English commands.
- [Cross-repo docs](https://docs.zarlabs.tech/features/cross-repo-docs.md): Keep documentation in a separate repository in sync with code changes in another.
- [Dashboard](https://docs.zarlabs.tech/features/dashboard.md): The ZAR dashboard — per-repo settings, the activity feed, and the run view that shows exactly what happened.
- [MDX & multilingual](https://docs.zarlabs.tech/features/mdx-and-multilingual.md): How ZAR handles .mdx / Nextra docs and multilingual sites — including frontmatter safety and language-variant syncing.
- [Notifications](https://docs.zarlabs.tech/features/notifications.md): How ZAR notifies you about documentation PRs and skipped commits, and how to control it.
- [PR feedback](https://docs.zarlabs.tech/features/pr-feedback.md): The comments, commit statuses, and docs PRs ZAR produces on a pull request.
- [Installation](https://docs.zarlabs.tech/installation.md): Install the ZAR GitHub App on your repositories, the permissions it requests, and what happens right after install.
- [Welcome to ZAR](https://docs.zarlabs.tech/introduction.md): Keep your repository documentation accurate as the code changes.
- [Plans](https://docs.zarlabs.tech/plans.md): ZAR's plan tiers, what each includes, and how access is determined.
- [Privacy](https://docs.zarlabs.tech/privacy.md): What data ZAR accesses, what it sends to third parties, what it stores, and your choices.
- [Quickstart](https://docs.zarlabs.tech/quickstart.md): Install ZAR on one repository and get your first documentation suggestion in about five minutes.
- [Commands reference](https://docs.zarlabs.tech/reference/commands.md): The complete syntax for ZAR's PR/issue comment commands, including aliases and accepted forms.
- [Environment variables](https://docs.zarlabs.tech/reference/environment-variables.md): Every environment variable ZAR reads — required, defaults, and what each one does. For self-hosting.
- [Permissions & events](https://docs.zarlabs.tech/reference/permissions-and-events.md): The GitHub App permissions ZAR requests, the webhook events it subscribes to, and its HTTP endpoints.
- [Settings reference](https://docs.zarlabs.tech/reference/settings.md): Every ZAR per-repository setting — type, default, range, where it can be set, and what it does.
- [Security](https://docs.zarlabs.tech/security.md): How ZAR protects your repository, how to report a vulnerability, and hardening guidance for operators.
- [Deploy with Docker](https://docs.zarlabs.tech/self-hosting/docker.md): Build and run ZAR as a container, with or without docker-compose.
- [Self-hosting overview](https://docs.zarlabs.tech/self-hosting/overview.md): Run your own ZAR instance — prerequisites, the GitHub App you register, and the minimal run command.
- [Deploy on Railway](https://docs.zarlabs.tech/self-hosting/railway.md): Run ZAR on Railway with managed Postgres and Redis.
- [Terms](https://docs.zarlabs.tech/terms.md): Terms of use for ZAR.
- [Troubleshooting](https://docs.zarlabs.tech/troubleshooting.md): Common ZAR symptoms and how to fix them.