colregs 0.3.0 → 0.3.2

package/README.md

@@ -35,7 +35,6 @@ data/facts.json          the fact record, and how to decode SignalK navigation.s
 data/applicability.json  predicate -> lights, each entry also carrying modality, citation, jurisdiction
 data/geometry.json       Annex I: heights, spacings, colour, intensity
 data/images.json         every image, its source, and what it illustrates
-data/deprecated-identifiers.json  retired identifiers: what they denoted, when, and their replacement
 images/                  38 USCG diagrams + 5 arc GIFs
 fixtures/                fact records and the entries that apply to them
 ```
@@ -82,13 +81,13 @@ loses.
 
 **Applicability entries.** Each is a predicate over facts, a set of lights or
 references to other entries, a modality, a citation, and a jurisdiction. Every
-entry has an id (`25b`, `27a-mw`) a consumer can point at.
+entry has an id (`rule:25b`, `rule:27a_iii`) a consumer can point at.
 
-**Identifiers.** Citation-derived ids (paragraph paths, entry ids) carry no
-prefix, because the path *is* the citation. Vocabulary ids do:
+**Identifiers.** Paragraph paths carry no prefix, because the path *is* the
+citation. Every other id names its namespace: `rule:30a`,
 `light:masthead`, `fact:activity`, `activity:nuc`, `rel:in_lieu_of`. Every
-identifier is immutable once published; retirements go through
-[`data/deprecated-identifiers.json`](data/deprecated-identifiers.json). See
+identifier is immutable from 1.0.0; before then it may be renamed or
+discarded outright, and the deprecation registry is absent. See
 [`docs/identifiers.md`](docs/identifiers.md).
 
 ## Design
@@ -144,16 +143,16 @@ paragraphs prevails is a relation.
 | `rel:exempts` | the referenced requirement does not apply (30(e)) |
 | `rel:overrides` | this paragraph's requirement prevails over the referenced one's when both apply (Rule 18; Rule 26(a) over Rule 30's anchor lights) |
 
-Modality is `shall`, `may`, `shall-if-practicable`, `shall-not`,
-`shall-not-impede`, or `conditional` with a `modality_by` table when it turns
+Modality is `modality:shall`, `modality:may`, `modality:shall-if-practicable`, `modality:shall-not`,
+`modality:shall-not-impede`, or `modality:conditional` with a `modality_by` table when it turns
 on a fact.
 
 Most entries read one vessel and produce lights. The Part B entries read
 **two**, a situation rather than a fact record, and produce an `effect`:
 which section governs, which vessel gives way, whether the encounter is
-`head-on`, `crossing` or `overtaking`. They address each vessel through a
-subject segment (`own:fact:activity`, `other:fact:propulsion`,
-`pair:geo:in_sight`); a key with no subject means `own:`. The encounter
+`encounter:head-on`, `encounter:crossing` or `encounter:overtaking`. They address each vessel through a
+subject segment (`self:fact:activity`, `other:fact:propulsion`,
+`pair:geo:in_sight`); a key with no subject means `self:`. The encounter
 sectors partition relative bearing, so no crossing sector is enumerated and
 none can drift. [`docs/identifiers.md`](docs/identifiers.md) has the
 vocabulary, [`docs/part-b-invariants.md`](docs/part-b-invariants.md) the
@@ -178,6 +177,9 @@ both vessels give-way.
 `fixtures/applicability-fixtures.json` and `fixtures/situation-fixtures.json`
 are the cross-implementation contract: an implementation in any language
 should reproduce those exactly.
+[`data/operations.json`](data/operations.json) names the verbs an engine
+implements and binds each to its input schema, its result schema and the
+fixture file that exercises it ([ADR 0014](docs/adr/0014-engine-interface-owned-by-colregs.md)).
 
 ## Provenance and licence