skills/mintlify__docs
1
0
Fork 0
mirror of https://github.com/mintlify/docs.git synced 2026-09-14 13:35:46 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
mintlify__docs/.github/pull_request_template.md
T
Ethan Palm 9f47b485e2 Edit PR template (#781) 
* add PR template

* github wanted different comment syntax

* remove comment syntax
2025-06-06 09:51:16 -07:00

740 B
Raw Permalink Blame History

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
Reference in New Issue View Git Blame Copy Permalink