docs: fix verified drift against pilotctl / registry / driver source#121
Merged
Conversation
Corrects documentation that described behavior the code does not implement,
and documents surfaces that shipped without docs. Every change was verified
against source in web4, rendezvous, policy, handshake, eventstream,
dataexchange, and common/driver.
- enterprise-audit: the six registry RPC examples used "command"; the
registry dispatches on "type" (rendezvous/server_api.go). Every example
was a copy-paste failure. s/"command"/"type"/ x6.
- webhooks: add the 13 emitted-but-undocumented events (trust.changed;
network.joined/left/tags_changed; tunnel.established/rekey_gave_up;
security.src_spoofed; pubsub.rate_limited; dataexchange.ack_failed;
policy.eval_error/prune_trust/fill_trust/join_denied) with payload
fields taken from each emitter.
- llms.txt: drop the false "stdlib-only / zero external dependencies"
claim (go.mod pulls coder/websocket, expr-lang/expr, golang.org/x, plus
the Pilot modules); remove the dead /docs/tasks.html and /docs/polo.html
links (no such pages).
- getting-started: quickstart prints a static banner; it does not detect
daemon state. Match cli-reference.
- go-sdk: write deadlines are now enforced per chunk (common/driver/conn.go),
not a no-op; add SetWriteDeadline and document DialAddrTimeout,
PreferDirect, Sign/Verify/VerifyMaxSkew envelope, Submit/Enroll badge/
recovery, Managed{Status,ForceCycle,Reconcile}, Policy{Get,Set},
MemberTags{Get,Set}.
- concepts: add PortVerify = 1003 to the well-known ports table.
- enterprise-policies / enterprise-blueprints: document set_expr_policy /
get_expr_policy, member-tag RPCs, and the blueprint expr_policy field.
- cli-reference: peers --all/--limit, inbox --from/--before, broadcast
admin-token requirement.
- enterprise: fix Go package qualifier (client.Client, not registry.Client);
document get_audit_export, get_webhook, set_identity_webhook,
set/get_member_tags, get_key_info.
Plain-text mirrors regenerated for all touched docs pages; astro build passes.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
🚀 Preview deployed to Cloudflare Pages
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Corrects documentation that described behavior the code does not implement, and documents surfaces that shipped without docs. Every change was verified against source (web4, rendezvous, policy, handshake, eventstream, dataexchange, common/driver). App cards / apps.ts are handled by a separate agent and untouched here.
High
"command", but the registry dispatches on"type"(rendezvous/server_api.go). Every copy-pasted example failed.s/"command"/"type"/x6.trust.changed;network.joined/network.left/network.tags_changed;tunnel.established/tunnel.rekey_gave_up;security.src_spoofed;pubsub.rate_limited;dataexchange.ack_failed;policy.eval_error/policy.prune_trust/policy.fill_trust/policy.join_denied.go.modpullscoder/websocket,expr-lang/expr,golang.org/x, plus the Pilot modules); removed the dead/docs/tasks.htmland/docs/polo.htmllinks (no such pages).Medium
quickstartprints a static banner and does not detect daemon state; matched cli-reference.common/driver/conn.go), not a no-op; addedSetWriteDeadlineand documentedDialAddrTimeout,PreferDirect, the reqsigSign/Verify/VerifyMaxSkewenvelope methods,SubmitBadge/EnrollRecovery,Managed{Status,ForceCycle,Reconcile},Policy{Get,Set},MemberTags{Get,Set}.PortVerify = 1003to the well-known ports table.set_expr_policy/get_expr_policy, the member-tag RPCs, and the blueprintexpr_policyfield.Low
peers --all/--limit,inbox --from/--before, and thebroadcastadmin-token requirement.client.Client, notregistry.Client); documentedget_audit_export,get_webhook,set_identity_webhook,set_member_tags/get_member_tags,get_key_info.Verification
Plain-text mirrors regenerated for all 10 touched docs pages via
scripts/regen-plain.mjs.npm run buildpasses clean (345 pages).🤖 Generated with Claude Code