docs: gate write-good.Passive on CI
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.
This commit is contained in:
parent
04e27c4fb6
commit
2346bef3b1
3 changed files with 11 additions and 9 deletions
|
|
@ -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
|
||||
# `<!-- vale write-good.Passive = NO/YES -->` pair rather than bulk-ignored.
|
||||
write-good.Passive = error
|
||||
|
||||
# --- Rules disabled against evidence from our own docs/ tree, not guessed ---
|
||||
#
|
||||
|
|
|
|||
|
|
@ -49,11 +49,3 @@ Run a LogsQL query and print the matched log lines
|
|||
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<!-- vale write-good.Passive = NO -->
|
||||
<small><i>
|
||||
This document was generated automatically by
|
||||
<a href="https://crates.io/crates/clap-markdown"><code>clap-markdown</code></a>.
|
||||
</i></small>
|
||||
<!-- vale write-good.Passive = YES -->
|
||||
|
|
|
|||
|
|
@ -90,7 +90,12 @@ fn main() -> Result<()> {
|
|||
query::run(&cfg, &logsql, limit, format, &mut stdout.lock())
|
||||
}
|
||||
Verb::MarkdownDocs => {
|
||||
print!("{}", clap_markdown::help_markdown::<Cli>());
|
||||
// `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::<Cli>(&options));
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue