docs(pull_request_template): add task to fix broken external links in the docs

bearomorphism · Lee-W · commit 47beadc563d8 · 2025-06-01T16:13:40.000+08:00
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -25,7 +25,7 @@ Please fill in the following content to let us know better about this change.
 ### Documentation Changes
 
 - [ ] Run `poetry doc` locally to ensure the documentation pages renders correctly
-  - [ ] Check if there are any broken links in the documentation
+- [ ] Check and fix any broken links (internal or external) in the documentation
 
 > When running `poetry doc`, any broken internal documentation links will be reported in the console output like this:
 >

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ Please fill in the following content to let us know better about this change.`
`25`	`25`	`### Documentation Changes`
`26`	`26`
`27`	`27`	- [ ] Run `poetry doc` locally to ensure the documentation pages renders correctly
`28`		`- - [ ] Check if there are any broken links in the documentation`
	`28`	`+- [ ] Check and fix any broken links (internal or external) in the documentation`
`29`	`29`
`30`	`30`	> When running `poetry doc`, any broken internal documentation links will be reported in the console output like this:
`31`	`31`	`>`