Documentation-Only PR Template
A lightweight PR template for documentation changes including README updates, API docs, guides, and inline code comments. No code testing required.
Detailed Explanation
Documentation-Only PR Template
Documentation PRs have different requirements than code PRs. They don't need compilation, unit tests, or type checking. This template is tailored for doc-only changes, reducing unnecessary checklist items while adding doc-specific quality checks.
Template Structure
## Description
<!-- What documentation is being added or updated? -->
## Type of Documentation
- [ ] README update
- [ ] API documentation
- [ ] User guide / tutorial
- [ ] Inline code comments
- [ ] Architecture decision record (ADR)
- [ ] Configuration documentation
## Checklist
- [ ] Spelling and grammar checked
- [ ] Links verified (no broken links)
- [ ] Code examples tested and working
- [ ] Screenshots are up to date
- [ ] Table of contents updated (if applicable)
- [ ] Consistent formatting with existing docs
## Preview
<!-- Link to a preview if available (e.g., Netlify deploy preview, GitHub Pages). -->
## Related Issues
<!-- Closes #(issue number) -->
Why a Separate Doc Template?
Using a code-focused template for doc PRs creates friction. Contributors have to mentally skip irrelevant checklist items like "unit tests pass" or "no new warnings." A dedicated template makes the process smoother.
Doc-Specific Quality Checks
- Spelling and grammar — poor writing quality undermines credibility
- Link verification — broken links degrade documentation usability over time
- Code examples tested — outdated code samples are worse than no samples
- Screenshot freshness — UI screenshots become stale as the product evolves
Preview Links
Many documentation systems (Docusaurus, GitBook, Nextra) generate deploy previews for PRs. Including a Preview section reminds contributors to share the preview URL for visual review.
ADR Documentation
Architecture Decision Records are a specific type of documentation that captures the context, decision, and consequences of significant technical choices. Including ADR as a documentation type recognizes its importance.
Use Case
Teams maintaining documentation alongside code in the same repository, especially open source projects where documentation contributions are common and should be easy to submit.