From 8a4f61ffec8c2cbd5b09bcea21b677de3638dfd9 Mon Sep 17 00:00:00 2001 From: Willie Date: Sun, 22 Feb 2026 10:20:48 +0800 Subject: [PATCH] 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. --- website/docs/commands/audit.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/website/docs/commands/audit.md b/website/docs/commands/audit.md index 9b6351ac4..0ef4bfa01 100644 --- a/website/docs/commands/audit.md +++ b/website/docs/commands/audit.md @@ -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 |