Open-source READMEs
Keep your README and quickstart honest as the public API moves.
Point ZAR at a repo. It reads the code, writes the docs, and keeps them in sync. Zero manual upkeep.
# 1. install the GitHub Appopen github.com/apps/zar-app # 2. choose the repos ZAR should watchSettings -> Install -> Select repositories # 3. open your next pull requestZAR reviews the diff and proposes doc updatesAdd the GitHub App, pick repositories, done.
ZAR reads each pull request and proposes the smallest doc change that makes the page true again. Stale lines go red, synced lines go green.
## Running locally Start the API, then open the dashboard: uvicorn app.main:app --port 8080 uvicorn app.main:app --port 8000 The webhook is served at `POST /webhook`.The webhook is served at `POST /github/webhook`.Run ZAR on any public repo and get a shareable report: architecture map, onboarding friction, and docs that drifted from the code.
Run a free teardownTree-sitter AST parsing reads structure, signatures, and symbols, not just text diffs.
def process_event(repo, diff): tree = parse(repo) # tree-sitter AST return changed_symbols(tree, diff)Docs written from your actual code. Minimal diffs, and never invented facts.
Every pull request triggers a check, so docs update with the code across repos.
Keep .mdx and Nextra docs consistent across languages, such as English and Kazakh.
Runs as a GitHub App. Comments, checks, and labels inside your review flow.
Real quotes are on the way. These slots are placeholders, not invented reviews.
Reserved for a real build-in-public note about docs staying current through a busy release.
Open-source maintainer
Reserved for a real quote about onboarding new engineers without a stale wiki slowing them down.
Platform engineer
Reserved for a real quote about shipping bilingual docs without a second writing pass.
Developer advocate
Reserved for a real quote about catching a drifted README inside the pull request, not after.
Engineering lead
Prices are early and may change before launch.
Public repos and a free teardown.
Private repos for solo developers.
Seats and cross-repo sync.
Self-host with an SLA.
Install the GitHub App, open a pull request, and watch your docs keep up with the code.