Architecture#

Markdown under a shared snell- prefix is the only source of truth. Quality gates and a local Tantivy index sit in front of Jira publication.

canonic architecture: markdown → quality → Tantivy → Jira

Pipeline: author in git → check/lint → search/dedupe → convert or import as review drafts. Neither direction writes Jira automatically.

Layers#

Layer

Responsibility

Corpus

corpus/responses/snell-*.md + front matter

Quality

check (prefix/sop/closings), lint engines

Index

Tantivy BM25 under .canonic-index/

Publish surface

convert (pandoc jira) / human paste

Import drafts

import-jira → corpus/imports/ only

Library map#

The CLI is a thin clap front end over the canonic library crate:

canonic library modules

Full API documentation is generated with rustdoc and linked from Rust API.

Free Jira platform map#

canonic uses only native Jira REST (Cloud Free API tokens or Server/DC PAT) — no Marketplace apps: