diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a0e9c39..94784a5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -32,6 +32,15 @@ jobs: )" test "${actual}" = "18d7218047bd77b599c0639b69c4fead31149beccbc13156fd387512bc818b91" + - name: Public documentation language + run: | + if rg -n -i '\b(boundary|path|surface|authority|projection|lowering|flow|layer)\b' \ + README.md relay \ + --glob '*.md' --glob '*.mdx'; then + echo "Public documentation must name the API, queue, process, service, or request directly." + exit 1 + fi + - name: Format run: cargo fmt --all -- --check diff --git a/relay/README.md b/relay/README.md index 7a06837..e4dbee0 100644 --- a/relay/README.md +++ b/relay/README.md @@ -97,7 +97,7 @@ publisher group, ICE configuration, and startup deadline. They therefore prepare and run as one publisher while retaining distinct source, stem, route, and bus identities. -## Configure the network path +## Configure the Relay connection ```rust,no_run # use std::time::Duration; @@ -143,7 +143,7 @@ All validation happens before media publication: | Errors | stable connector code, provider stage, diagnostic, retryability | | Outcomes | per-route receipt correlated to source, stem, route, and bus | -Core remains the lifecycle authority: +Core controls the Connector lifecycle: ```text Session prepare diff --git a/relay/RELEASE_NOTES.md b/relay/RELEASE_NOTES.md index e00b824..d07ea3d 100644 --- a/relay/RELEASE_NOTES.md +++ b/relay/RELEASE_NOTES.md @@ -15,7 +15,7 @@ This release requires `pocketstation 1.1.3`, which introduced output generation ownership for application-provided audio. Cancellation cannot recall RTP packets already sent to Relay or audio already -buffered by a receiver. A complete interruption path must also clear receiver +buffered by a receiver. Complete interruption handling must also clear receiver playout when that receiver provides the capability. ### Upgrade diff --git a/relay/tests/fixtures/README.md b/relay/tests/fixtures/README.md index c78078f..771e496 100644 --- a/relay/tests/fixtures/README.md +++ b/relay/tests/fixtures/README.md @@ -1,8 +1,8 @@ # Connector conformance data `connector-v1-vectors.json` is the packaged copy of -`protocol/conformance/connector/v1/vectors.json`. The source file remains the -protocol authority. Connector CI verifies this copy against the canonical +`protocol/conformance/connector/v1/vectors.json`. That source file defines the +protocol. Connector CI verifies this copy against the recorded SHA-256 value before running the portable semantics test. When the protocol corpus changes, update the packaged file and its CI hash in