From 2346bef3b12c5f3a4f999aa22d8d085a14ccb944 Mon Sep 17 00:00:00 2001 From: iris Date: Sun, 20 Sep 2026 15:07:50 +0200 Subject: [PATCH] docs: gate write-good.Passive on CI MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Both blockers are done — #4548 (353 hits in hand-written docs) and #4549 (46 hits in generated CLI reference docs, hivectl/swarmctl/hive-forge's own clap help text) — and the previous commit suppresses the reviewed false-positive remainder. vale --minAlertLevel=error docs now returns 0 errors, matching CI's existing prose-lint-errors job. Closes #4546. --- .vale.ini | 5 +++++ docs/tools/swarm-logs-cli.md | 8 -------- swarm-logs/src/main.rs | 7 ++++++- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/.vale.ini b/.vale.ini index 3643495c..b8023a93 100644 --- a/.vale.ini +++ b/.vale.ini @@ -11,6 +11,11 @@ Packages = Microsoft, alex, write-good [*.md] BasedOnStyles = Microsoft, alex, write-good +# Gated on CI (hyperhive#4546) once the existing backlog cleared to zero +# (hyperhive#4548, hyperhive#4549) — every remaining hit at the time of this +# flip is a reviewed false positive, individually wrapped in a scoped +# `` pair rather than bulk-ignored. +write-good.Passive = error # --- Rules disabled against evidence from our own docs/ tree, not guessed --- # diff --git a/docs/tools/swarm-logs-cli.md b/docs/tools/swarm-logs-cli.md index 999b9a58..092375e8 100644 --- a/docs/tools/swarm-logs-cli.md +++ b/docs/tools/swarm-logs-cli.md @@ -49,11 +49,3 @@ Run a LogsQL query and print the matched log lines -
- - - - This document was generated automatically by - clap-markdown. - - diff --git a/swarm-logs/src/main.rs b/swarm-logs/src/main.rs index 6096559d..340e1c6d 100644 --- a/swarm-logs/src/main.rs +++ b/swarm-logs/src/main.rs @@ -90,7 +90,12 @@ fn main() -> Result<()> { query::run(&cfg, &logsql, limit, format, &mut stdout.lock()) } Verb::MarkdownDocs => { - print!("{}", clap_markdown::help_markdown::()); + // `show_footer(false)`: drop clap-markdown's own fixed + // "generated automatically by..." footer, same as + // hivectl/swarmctl/hive-forge — it's not our prose, and + // write-good.Passive has nothing to check it against. + let options = clap_markdown::MarkdownOptions::new().show_footer(false); + print!("{}", clap_markdown::help_markdown_custom::(&options)); Ok(()) } }