Skip to content

docs: module map diagram for contributor onboarding - #1

Merged
acenji merged 1 commit into
mainfrom
ivan
Jul 1, 2026
Merged

docs: module map diagram for contributor onboarding#1
acenji merged 1 commit into
mainfrom
ivan

Conversation

@acenji

@acenji acenji commented Jul 1, 2026

Copy link
Copy Markdown
Owner

Adds docs/module-map.md — a contributor-facing architecture diagram:

  • Zone/module map (Mermaid): all 21 crates across the four trust zones, one-way election-lifecycle flow (County→Precinct→County→Public), license-colored, with an embedded legend + artifact glossary (EDC/SAC/BAT/CVR/PVP).
  • Election-day sequence (Mermaid): the Ballot Activation Token (BAT) path from check-in → BMD → paper ballot → scan → tabulate, with a legend bar.
  • 21-crate table and a "where to start" section for new contributors.
  • README: new "Architecture at a glance" section linking the map.

Renders inline on GitHub (Mermaid → SVG, lossless zoom). No code changes.

🤖 Generated with Claude Code

Add docs/module-map.md — a Mermaid zone/module map of all 21 crates across
the four trust zones (one-way lifecycle flow, license-colored, with a legend
and artifact glossary) plus a BAT election-day sequence diagram. Link it from
the README architecture section.
@acenji
acenji merged commit 7e9e890 into main Jul 1, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant