Skip to content

Latest commit

 

History

History
32 lines (25 loc) · 1.21 KB

File metadata and controls

32 lines (25 loc) · 1.21 KB

Relay documentation index

Relay installs from the relay-lint distribution, exposes the relay command, imports as relay, and uses the normalized relay_lint name in wheel filenames. I keep those names here because release instructions should make the boundary obvious.

Start and configure

  • Tutorials: small Arduino, polyglot, timing-contract, and CI workflows.
  • Configuration: relay.toml, bounds, rules, and bundled configuration schema.
  • Rules: stable RLY101–RLY115 catalogue.
  • Timing model: what contracts and summaries do and do not estimate.

Interpret and integrate

  • Limitations: AST and structural-model boundaries.
  • Schemas: versioned JSON report and configuration contracts.
  • Architecture: discovery, analysis, rule, and reporting flow.
  • Security: inert-source handling, limits, and report writes.
  • Roadmap: possible work after the current alpha.

Build and cite