File tree Expand file tree Collapse file tree 1 file changed +28
-0
lines changed
Expand file tree Collapse file tree 1 file changed +28
-0
lines changed Original file line number Diff line number Diff line change 1+ ## Documentation changes
2+
3+ <!-- Brief description of what's being updated -->
4+
5+ Closes <!-- Linear ticket or GitHub issue -->
6+
7+ ---
8+
9+ ## For Reviewers
10+
11+ When reviewing documentation PRs, please consider:
12+
13+ ### ✅ Technical accuracy
14+ - [ ] Code examples work as written
15+ - [ ] Commands and configurations are correct
16+ - [ ] Links resolve to the right destinations
17+ - [ ] Prerequisites and requirements are accurate
18+
19+ ### ✅ Clarity and completeness
20+ - [ ] Instructions are clear and easy to follow
21+ - [ ] Steps are in logical order
22+ - [ ] Nothing important is missing
23+ - [ ] Examples help illustrate the concepts
24+
25+ ### ✅ User experience
26+ - [ ] A new user could follow these docs successfully
27+ - [ ] Common gotchas or edge cases are addressed
28+ - [ ] Error messages or troubleshooting guidance is helpful
You can’t perform that action at this time.
0 commit comments