MergeWatch documentation

The source for docs.mergewatch.ai — the user-facing documentation for MergeWatch, an open-source AI code review GitHub App.

Built with Mintlify. Pages are MDX files with YAML frontmatter; navigation and site config live in docs.json.

Repository layout

.
├── docs.json                 # Mintlify nav, theme, metadata
├── overview/                 # What MergeWatch is and how to get started
├── self-hosting/             # Docker Compose install + LLM providers + platform guides
├── configuration/            # .mergewatch.yml, skip rules, conventions, custom instructions
├── github-app/               # Permissions, webhook events, install flows
├── deployment/               # Architecture, deployment models, SAM template reference
├── dashboard/                # Dashboard pages (reviews, analytics, settings, etc.)
├── saas/                     # Managed SaaS — getting started, billing, data residency
├── reference/                # CLI/commands, env vars, changelog, FAQ, troubleshooting
├── images/ logo/ favicon.svg # Assets
└── AGENTS.md                 # Style + terminology guide for contributors and AI tools

Local development

Install the Mintlify CLI:

npm i -g mint

From the repo root (where docs.json lives):

mint dev

This serves the site at http://localhost:3000 with live reload.

Check for broken internal links before opening a PR:

mint broken-links

Contributing

1. Branch from main (e.g., fix/env-vars-clarification, docs/new-platform-guide).
2. Edit or add MDX files. When adding a new page, include it in the relevant group inside docs.json so it appears in the nav.
3. Follow the style rules in AGENTS.md — active voice, sentence-case headings, bold for UI elements, code formatting for file names and commands.
4. Run mint dev to preview and mint broken-links to verify links.
5. Open a PR. Mintlify auto-deploys from main once merged.

When documentation drifts from the MergeWatch codebase, fixes should cite the source of truth in the PR description (e.g., packages/core/src/config/defaults.ts:120 or infra/template.yaml:59) so the claim can be verified.

Deployment

Pushes to main deploy automatically to docs.mergewatch.ai via the Mintlify GitHub App. There is no separate build or publish step.

AI-assisted writing

This repo includes an AGENTS.md with style conventions. For Mintlify-specific component and configuration guidance, install the Mintlify skill into your AI tool:

npx skills add https://mintlify.com/docs

Works with Claude Code, Cursor, Windsurf, and other AI tools that support skills.

Getting help

• MergeWatch product questions: github.com/santthosh/mergewatch.ai
• Docs issues (typos, broken links, unclear pages): open an issue or PR in this repo
• Mintlify platform questions: mintlify.com/docs

License

Documentation content is licensed under MIT. The MergeWatch product itself is licensed under AGPL v3.