mix raxol.check_docs (Raxol v2.6.1)

View Source

Validate documentation against the code and the house prose rules.

Two independent checks:

  • Counts. Playground demo and category counts quoted in prose are compared against Raxol.Playground.Catalog, so a doc cannot claim a number the catalog does not produce.
  • Prose. Every tracked .md is linted by Raxol.Docs.ProseLint: unicode punctuation, -- as an em-dash substitute, broken relative links and anchors. Title Case headings are opt-in via --headings.

Usage

mix raxol.check_docs                    # everything, all tracked Markdown
mix raxol.check_docs --only prose       # skip the catalog counts
mix raxol.check_docs --only counts      # skip the prose lint
mix raxol.check_docs --files a.md b.md  # lint just these (pre-commit hook)
mix raxol.check_docs --headings         # add the opt-in heading-case sweep
mix raxol.check_docs --headings --warnings-as-errors

Heading case is off by default and warning-only when enabled: proper nouns are indistinguishable from common words without a dictionary. Use --headings for a sweep, and --warnings-as-errors to make it fail.