Skip to content

Protocol page: the checker's --probe mode, checking a server, and optional features - #26

Merged
tactino merged 1 commit into
mainfrom
docs/protocol-2026-10
Oct 3, 2026
Merged

tactino merged 1 commit into
mainfrom
docs/protocol-2026-10

Conversation

@tactino

@tactino tactino commented Oct 3, 2026

Copy link
Copy Markdown
Member

The protocol page described the checker as it was before --probe, and it said nothing about negotiated features. This PR brings it up to plugrl-protocol's SPEC.md and README. English and Chinese pages alike.

Checking a client

  • The page used to list what the checker cannot see and say a client breaking all of it "still prints no violations". That stopped being true with --probe, so the passage is removed.
  • In its place: the probe environment (SPEC.md §8.1), and the basic, resync and text scenarios, which now check the chunk-summed reward, the terminal observation, time-major actions, the connection options and close handling.
  • The page also lists the four §8 clauses that stay unchecked even with --probe, and why: from the wire, a correct client and a wrong one look the same.

Checking a server (new)

  • plugrl-conformance-server and what it checks (§8.2), plus examples/reference_server.py.
  • plugrl-server passes. Its CI runs the server checker on every change; I checked .github/workflows/ci.yml.

Optional features (new)

  • The protocol is still version 1. Changes are negotiated as features, as SPEC.md §10 says.
  • The one feature so far is reuse-feedback-obs (§10.1). The page gives what it saved in E46 and the checker flags that exercise it.

Check: the site's CI (mkdocs build --strict) on this PR.

…ional features

- Checking a client: the page said the checker cannot see the chunk-summed reward, the terminal
  observation, the action layout, the connection options or the close handling, and that a
  client breaking them all prints "no violations". `--probe` with the probe environment
  (SPEC.md 8.1) and `--scenario basic|resync|text|all` now checks those; the four clauses that
  stay unchecked, and why, are listed instead.
- Checking a server: plugrl-conformance-server, examples/reference_server.py, plugrl-server's CI.
- Optional features: protocol version 1 with negotiated features (SPEC.md 10), and
  reuse-feedback-obs (10.1) with E46's measurement.
English and Chinese pages alike.
@tactino
tactino merged commit 75834df into main Oct 3, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant