Documentation
Fidryn documentation
On this page
Fidryn (pronounced FID-rin) is a programming language for legal instruments: precise where law is mechanical, explicit where judgment enters, and incapable of hiding authority, discretion, or ambiguity inside a Boolean.
This directory is the human documentation for the v0.1 reference interpreter. Start at the product README to clone and build, then read Getting started. The modules, records, and examples in this repository are research fixtures. They are not legal advice, not operative instruments, and not a complete statement of any jurisdiction's law.
For users #
| Guide | What it is for |
|---|---|
| Getting started | First hour: build, check, run |
| Language | .fr modules, queries, rules, duties, verify |
| CLI | Every fidryn subcommand and flag |
| Mill | Localhost UI on 127.0.0.1 |
| Cases and time | Case records, valid time, known-at |
| Outcomes | Determinate, Suspended, Contingent, and the rest |
| Examples | Trust, tax, federal slices, fifty states |
The closed grammar is grammar.ebnf. Wire formats
are schemas/case-record-v0.1.json,
schemas/outcome-v0.1.json, and
schemas/evaluation-report-v0.1.json
(CLI run / explore and mill eval responses nest the outcome as
outcomeDocument).
For implementers #
| Document | What it is |
|---|---|
| Contributing | Toolchain, tests, commits |
| Architecture | Pipeline and crate contract |
| Implementation status | Evidence-backed capability matrix |
| Obligations | Review obligations; green tests are regressions |
| Integration contract | How existing machinery must be wired |
| Workstream contract | Covering, require, tax, trust profiles |
| Review-fix contract | Historical pass-3 repair brief |
| Full implementation | Older deferred-work list; status is the matrix |
Mill HTTP routes live in mill.md, not in Architecture.
The modules, records, and examples here are research fixtures. They are not legal advice, not operative instruments, and not a complete statement of any jurisdiction’s law.