1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
<!--
Welcome! Thank you for contributing to our documentation.
Your efforts help improve the project for everyone.
-->
# Documentation PR Template
## Summary
<!-- Provide a brief description of the documentation changes -->
## Type of Documentation
<!-- Check all that apply -->
- [ ] API documentation
- [ ] User guide/manual
- [ ] Technical documentation
- [ ] README updates
- [ ] Code comments
- [ ] Architecture documentation
- [ ] Other: _________________
## Motivation and Audience
<!-- Briefly explain why this documentation is needed and who will use it -->
## Changes Made
<!-- List the key additions, updates, or removals -->
- Added:
- Modified:
- Removed:
## Quality Checklist
<!-- Check all completed items -->
- [ ] Technical accuracy verified
- [ ] Code examples tested (if applicable)
- [ ] Links verified and working
- [ ] Clear and concise language used
- [ ] Examples included where helpful
- [ ] Proper formatting and structure used
- [ ] Screenshots/diagrams updated (if applicable)
## Documentation Location
<!-- Where can reviewers find the documentation? -->
## Related Issues
<!-- Link to any related issues, e.g., "Closes #123" -->
## Additional Notes
<!-- Any additional information the reviewers should know -->
## Reviewers
<!-- Suggest reviewers who should check this documentation -->