You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+7
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,13 @@ 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
29
+
30
+
> When running `poetry doc`, any broken internal documentation links will be reported in the console output like this:
31
+
>
32
+
> ```text
33
+
> INFO - Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.
34
+
> ```
28
35
29
36
## Expected Behavior
30
37
<!-- A clear and concise description of what you expected to happen -->
0 commit comments