Commentary Docs
Commentary helps teams review Markdown like a document instead of a diff. It opens GitHub pull requests and repository branches in a reading-first workspace, keeps rendered Markdown at the center, and lets reviewers comment on paragraphs instead of raw line numbers.
These docs are written for customers using commentary.dev. They focus on the product as it works today: public PR review, authenticated commenting, GitHub OAuth with a PAT fallback, and direct branch review outside a pull request.
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
- Connecting GitHub: Access and authentication
- Creating a token for the PAT fallback: Generate a GitHub PAT
- Want a guided sandbox: Demo walkthrough
- Hit a rough edge: Troubleshooting and FAQ
Fast Paths
- Open the homepage at /.
- Paste a public GitHub pull request URL and click
Open review. - Read the document in
Previewmode. - When you want to comment or reply, click
Sign inand continue with GitHub, or use the personal access token option from the advanced path.
If you want to explore Commentary without bringing your own repository first, open /demo.
If you want to review Markdown directly from a branch before a PR exists, open /, expand the repository path, and click Open docs.
What Commentary Is Best At
- Product specs, launch plans, ADRs, and long-form Markdown docs
- Readable review for people who do not want to work in raw diffs all day
- Mixed review flows where some comments need to sync back to GitHub and some stay native to Commentary
- Early feedback on repository docs before a pull request exists
Current Product Shape
- Public PRs open without login for read-only review.
- Commenting and replies require GitHub authentication.
- Pull request review supports
PreviewandRaw, plusLatestandDiff. - Branch review uses the same shell, but comments stay app-native and there is no
Submit reviewstep. - OAuth is the default sign-in path.
Use PATis available as the fallback path.
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.