Reference · documentation governance

ENTITY Documentation Model

Use this page before deciding that a document, example or version label is a protocol requirement.

Current map: ENTITY runtime v3.4.3 · Blackmore Technology Data Universe (BTDU) 3.4.2 unchanged · ENTITY Protocol 1.0 is a separate frozen external clean-room target.

Five document classes

1. Normative Protocol 1.0 / sealed conformance material

The frozen external clean-room target lives in the ENTITY Protocol 1.0 External Conformance Kit. Its profile, canonicalization/cryptography rules, schemas, vectors, pass criteria and sealed manifests define that campaign. Later runtime material does not silently add Protocol 1.0 requirements.

2. Current ENTITY runtime

ENTITY v3.4.3 is the current supported BTG reference/runtime release. Runtime documentation can describe behavior and architecture developed after the Protocol 1.0 freeze.

3. BTDU component / runtime architecture

BTDU means Blackmore Technology Data Universe. In ENTITY v3.4.3 it remains component version 3.4.2 unchanged. Public architecture describes ENTITY for authority/rights, ADAM as deterministic state engine, NIKI as reasoning consumer and BTDU as the governed information substrate. These are not automatically Protocol 1.0 clean-room requirements.

4. Domain, adapter and integration material

Healthcare, Finance, Manufacturing, AI, Robotics, Defence and the GitHub App configure or integrate ENTITY. They do not create separate sovereignty systems or silently redefine ENTITY or external standards.

5. Historical / frozen evidence

Older release notes, signed manifests, v3.4.2 language campaigns, package bindings, receipts and hashes remain tied to the target that produced them. They are not rewritten merely because the supported runtime advanced.

Define first, bound second

Documentation should first explain what an object, state or relationship is, how it is established and what role it plays. Only then should it state what unrelated claims do not follow automatically.

Version wording

The word current must name its layer. A frozen v3.4.2 Java campaign can still be the repository's active test command while v3.4.3 is the current supported ENTITY runtime. Prefer “frozen v3.4.2 campaign target” over ambiguous wording such as “current v3.4.2 release.”

Sovereignty, provenance and economic boundary

UPSTREAM OWNERSHIP
        ≠
BTG FORK CUSTODY
        ≠
BTG-CREATED ENTITY METADATA OWNERSHIP
        ≠
ENTITY PROTOCOL ORIGIN
        ≠
AUTOMATIC ECONOMIC RIGHTS

Registration, ingestion, mirroring, provenance, custody or verification establish only the bounded facts actually represented and verified. They do not themselves transfer upstream ownership or create automatic economic entitlement.

Evidence classes

BTG-controlled release/qualification evidence.
Sealed campaign evidence.
BTG-controlled cross-language reproducibility.
External reproduction of a published BTG target.
Independent implementation authored outside BTG control.
Independent live interoperability/recovery evidence.
Independent security/research/deployment evidence.

One class does not silently upgrade into another.

What is deliberately not rewritten

sealed Protocol 1.0 vectors and signed kit manifests;
historical release hashes, tags and receipts;
frozen v3.4.2 expected results;
historical domain-package hashes/bindings;
external contributor evidence;
the active 30-day wall-clock campaign.

If a frozen artifact is confusing, explanatory documentation is improved around it rather than falsifying the artifact.

Cross-repository remediation is tracked in ENTITY #91.