From 3d90a8e0b3b5923bba4d2fc9e98866c05de9f965 Mon Sep 17 00:00:00 2001 From: JohnnyT Date: Sat, 26 Sep 2026 11:55:57 -0600 Subject: [PATCH] Rewords the doc_links comment in .quality.exs The comment beside the Docs and Doc links stages said the Doc links stage fails on "a published relative link to a file that is not an extra", which reads as covering moduledoc links too. The stage reads relative links in the Markdown extras and the README only; moduledoc links are the Docs stage's. The comment now carries the wording the other packages in the family use. No stage option changes. The gate-change log gains the entry the Gate guard requires, with its Approved-by line left for the operator to fill. Refs: st-1kyb --- .quality.exs | 5 +++-- docs/quality-gate-changes.md | 15 +++++++++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/.quality.exs b/.quality.exs index 6475be28..209ef5e8 100644 --- a/.quality.exs +++ b/.quality.exs @@ -34,8 +34,9 @@ # way HexDocs and hex.pm will read them. The Docs stage runs `mix docs` and # fails on any ExDoc warning. The Doc links stage fails on the link rules # ExDoc accepts silently: a README relative link to a file not in the - # package files, a published relative link to a file that is not an extra, - # two extras sharing a basename, and a silent rewrite to a different extra. + # package files, a relative link in a Markdown extra to a file that is not + # itself an extra (moduledoc links are the Docs stage's), two extras sharing + # a basename, and a silent rewrite to a different extra. # `:auto` runs both whenever ex_doc is installed, which it is in dev. docs: [enabled: :auto], doc_links: [enabled: :auto], diff --git a/docs/quality-gate-changes.md b/docs/quality-gate-changes.md index 4f56bea0..5849614b 100644 --- a/docs/quality-gate-changes.md +++ b/docs/quality-gate-changes.md @@ -13,6 +13,21 @@ Adding an entry is not permission to weaken a check. ADR-0011 says a genuinely wrong check is a human call, and this file is where that call is recorded, not where an agent grants itself one. +## 2026-09-26 - st-1kyb + +Approved-by: + +- .quality.exs: rewords the comment beside the Docs and Doc links stages so + it says what the Doc links stage checks; no stage option changes + +Reason: the comment said the Doc links stage fails on "a published relative +link to a file that is not an extra", which reads as covering every +published relative link, moduledoc links included. The stage reads relative +links in the Markdown extras and the README only; a relative link in a +moduledoc is the Docs stage's job. The comment now carries the wording the +other packages in the family use. A comment-only change: it adds no stage, +loosens nothing, skips no existing check, and lowers no threshold. + ## 2026-09-23 - st-bdpe Approved-by: JohnnyT (the operator's campaign consent of 2026-09-23, which