mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
9f47b485e2
* add PR template * github wanted different comment syntax * remove comment syntax
29 lines
740 B
Markdown
29 lines
740 B
Markdown
## Documentation changes
|
|
|
|
Brief description of what's being updated
|
|
|
|
Closes
|
|
|
|
---
|
|
|
|
## For Reviewers
|
|
|
|
When reviewing documentation PRs, please consider:
|
|
|
|
### ✅ Technical accuracy
|
|
- [ ] Code examples work as written
|
|
- [ ] Commands and configurations are correct
|
|
- [ ] Links resolve to the right destinations
|
|
- [ ] Prerequisites and requirements are accurate
|
|
|
|
### ✅ Clarity and completeness
|
|
- [ ] Instructions are clear and easy to follow
|
|
- [ ] Steps are in logical order
|
|
- [ ] Nothing important is missing
|
|
- [ ] Examples help illustrate the concepts
|
|
|
|
### ✅ User experience
|
|
- [ ] A new user could follow these docs successfully
|
|
- [ ] Common gotchas or edge cases are addressed
|
|
- [ ] Error messages or troubleshooting guidance is helpful
|