Skip to content

Enforce concrete public documentation #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Raphjacksun7 merged 1 commit into from
Sep 2, 2026
Merged

Enforce concrete public documentation #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions relay/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion relay/RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions relay/tests/fixtures/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down