Skip to content

Commit 7abeb9d

Browse files
btiernayclaude
andcommitted
refactor: align PR template with Auth0 style and add redirects section
- Add emoji headings to match Auth0 PR conventions - Add dedicated Redirects section with guidance and JSON example - Link to .claude/skills/writing-auth0-docs/SKILL.md for authoring guidelines - Add References section for Jira tickets and product specs - Remove feature flag references (not applicable to public docs repo) - Emphasize Mintlify auto-deployment on merge 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 311b368 commit 7abeb9d

File tree

1 file changed

+41
-7
lines changed

1 file changed

+41
-7
lines changed

.github/pull_request_template.md

Lines changed: 41 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Summary
1+
## ✏️ Changes
22

33
Briefly describe what this PR changes and why. If this touches multiple documentation sites (`main/` and `auth4genai/`), call that out.
44

5-
## Documentation scope
5+
## 📁 Documentation scope
66

77
**Site(s) affected:**
88
- [ ] `main/` - Auth0 main documentation
@@ -18,7 +18,13 @@ Briefly describe what this PR changes and why. If this touches multiple document
1818
- [ ] UI component or Mintlify configuration
1919
- [ ] Linting/tooling/workflows
2020

21-
## Verification
21+
## 🔗 References
22+
23+
Link to Jira issues, product specs, or related discussions:
24+
25+
https://auth0team.atlassian.net/browse/<issue>
26+
27+
## ✅ Verification
2228

2329
**Local validation:**
2430
- [ ] Ran `mint dev` in affected docs folder(s)
@@ -27,26 +33,54 @@ Briefly describe what this PR changes and why. If this touches multiple document
2733
- [ ] Built UI library with `npm run build` (if UI changes)
2834

2935
**Style compliance:**
36+
- [ ] Follows [Auth0 Docs authoring guidelines](.claude/skills/writing-auth0-docs/SKILL.md)
3037
- [ ] Follows placeholder conventions (`YOUR_SOMETHING`, `<id-value>`)
3138
- [ ] Uses correct Auth0 terminology and sentence case for headings
3239
- [ ] Code blocks include language and filename where appropriate
3340
- [ ] All images wrapped in `<Frame>` components
3441

35-
## Impact and dependencies
42+
## 🔄 Redirects
43+
44+
**Required if:**
45+
- [ ] Pages are being removed or URLs are changing
46+
- [ ] Navigation structure changes affect existing URLs
47+
48+
If redirects are needed, add them to the `redirects` array in the appropriate `docs.json` file:
49+
```json
50+
{
51+
"source": "/docs/old-path",
52+
"destination": "/docs/new-path"
53+
}
54+
```
55+
56+
## 📊 Impact
3657

3758
**User-facing changes:**
3859
- Does this introduce new pages, remove pages, or change URLs?
3960
- Does this document a new feature, Early Access capability, or breaking change?
4061
- Are there plan restrictions (Enterprise/Professional) that need callouts?
4162

4263
**Dependencies:**
43-
- Are there related PRs, feature flags, or release timing considerations?
64+
- Are there related PRs or release timing considerations?
4465
- Does this require coordination with Product, Legal, or Security teams?
4566

46-
**Follow-up required:**
67+
## 🚀 Deployment
68+
69+
✅🚫 This can be deployed any time (Mintlify auto-deploys on merge to main)
70+
71+
<!--
72+
OR
73+
⚠️ This should not be merged until:
74+
- Other PR is merged because REASON
75+
- After date because REASON
76+
- Other condition: REASON
77+
-->
78+
79+
## 📝 Follow-up
80+
4781
- [ ] No follow-up needed
4882
- [ ] Follow-up issue/PR needed (describe below)
4983

50-
## Additional context
84+
## 💬 Additional context
5185

5286
Add any other context, screenshots, or preview links that help reviewers.

0 commit comments

Comments
 (0)