Rust API#

The canonic library crate exposes the same engines the CLI uses: corpus load, quality checks, pandoc convert, Tantivy search/dedupe, lint, and Jira read-path import.

rustdoc

Full type-level docs generated by cargo doc and shipped next to this site when you run ./docs/build.sh.

Open rustdoc →

Module overview#

  • corpus

    Walk and load snell-*.md responses with front matter.

  • check

    Quality gate: prefix, sop, ids, team-generic closings.

  • convert

    Pandoc markdown ↔ Jira wiki markup.

  • index

    Tantivy reindex, BM25 search, near-duplicate pairs.

  • lint

    Vale CLI and in-process Harper grammar checks.

  • doctor

    Tooling presence (pandoc, Vale, Harper).

  • jira_import

    REST v2 search + comments → review drafts only.

crate canonic module map

Public modules re-exported from canonic:: — see rustdoc for signatures and examples.

Build rustdoc alone#

cargo doc --no-deps --open
# or via the site build (copies into docs/build/rustdoc/):
./docs/build.sh