Commentary Docs
Commentary helps teams review Markdown like a document instead of a diff. It opens GitHub and Azure DevOps pull requests, branches, files, folders, and repositories in a reading-first workspace, keeps rendered Markdown at the center, and lets reviewers comment on paragraphs and semantic blocks instead of raw line numbers.
These docs are written for people using commentary.dev. They cover public read-only review, authenticated commenting, GitHub App access, Azure DevOps access, personal access token fallbacks, the workspace, API access, and MCP.
Start Here
- New to Commentary: Getting started
- Need the product model first: Core concepts
- Reviewing a pull request: Review pull requests
- Reviewing docs before a PR exists: Review repository branches
- Managing repository queues: Workspace
- Using Azure DevOps: Azure DevOps
- Understanding review modes: Review modes
- Markdown behavior: Markdown rendering
- Connecting accounts: Access and authentication
- Using API or MCP clients: API and MCP
- Creating a GitHub fallback token: Generate a GitHub PAT
- Trying the sandbox: Demo walkthrough
- Hit a rough edge: Troubleshooting and FAQ
Fast Paths
- Open /.
- Paste a GitHub or Azure DevOps PR, branch, repository, file, or folder URL.
- Click
Open review. - Read in
PreviewandLatest. - Sign in when you want to comment, reply, refresh private content, or submit a review.
For a guided sample, open /demo. For cross-repository work, sign in and open /workspace.
Current Product Shape
- Public GitHub PRs open without login for read-only review.
- Commenting, replies, review submission, private content, workspaces, API tokens, and MCP access require authentication.
- GitHub App is the default GitHub connection for workspace discovery and private access. GitHub PAT remains the advanced fallback.
- Azure DevOps supports Microsoft Entra sign-in and PAT fallback.
- Pull request review supports
Preview,Raw,Latest,Diff, all-change and commit-specific change sets, comments, refresh, and review submission. - Direct document review supports branches, folders, files, branch selectors, commit-specific diff context, and Commentary-only comments.
- The public API and MCP endpoint let approved clients read anchors and comments, create comments, reply, and update thread status.
In This Repo
This repository is also the public branch review example for Commentary's direct document review flow. The root README.md is the landing page for /docs, and the rest of the guides live in docs/ with relative Markdown links between them.