Skip to content

Commit f2ee5e1

Browse files
authored
Merge pull request #24667 from dvdksn/dvdksn/scanner-broken-link-clarification
Clarify docs-scanner broken link rule
2 parents 75ad2e5 + ac4956f commit f2ee5e1

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

.github/agents/docs-scanner.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,10 @@ agents:
108108
109109
## What not to file
110110
111-
- **Broken links** — htmltest catches these; do not file
111+
- **Broken links** — htmltest catches these; do not file. This includes
112+
links to non-existent files within the repo ("broken cross-reference"
113+
is still a broken link). Only file if the URL resolves but the
114+
surrounding prose misdescribes the destination.
112115
- **Single time-relative words** in otherwise accurate sentences —
113116
"currently", "recently", "still", "yet", "usually" — Vale already flags
114117
these; your job is to find problems Vale can't see

0 commit comments

Comments
 (0)