docs: clarify dangling-link is a structural check, not in rules.yaml

The built-in rule IDs table listed dangling-link alongside regex-based
rules with a "source of truth" link to rules.yaml, but dangling-link
uses filesystem lookups (os.Stat) and is not defined there. Add a note
explaining the distinction to avoid confusion.
This commit is contained in:
Willie
2026-02-22 15:13:10 +08:00
parent 0d3799d770
commit 8a4f61ffec
+7 -1
View File
@@ -646,9 +646,15 @@ Summary interpretation:
Use `id` values to override or disable specific built-in rules:
Source of truth (full built-in definitions):
Source of truth for regex-based rules:
[`internal/audit/rules.yaml`](https://github.com/runkids/skillshare/blob/main/internal/audit/rules.yaml)
:::note Structural checks
`dangling-link` is not defined in `rules.yaml` — it is a **structural check** that verifies local markdown link targets exist on disk (using filesystem lookups, not regex). It still appears in the table below and can be disabled via `audit-rules.yaml` like any other rule.
:::
| ID | Pattern | Severity |
|----|---------|----------|
| `prompt-injection-0` | prompt-injection | CRITICAL |