Skip to content

Refresh stale README, conformance, and guide claims #51

@nficano

Description

@nficano

Several user-facing docs and source comments no longer match the implementation. ARCPClient still says richer operations such as invoke land in a later phase at Sources/ARCP/Client/ARCPClient.swift:4, even though invoke, cancellation, permission handling, and result chunk streams are present. JWTAuthValidator mentions an optional principalMapper at Sources/ARCP/Auth/JWTAuth.swift:7, but no such initializer parameter exists. CONFORMANCE.md:15 names session.accept and session.ready, while the code implements session.accepted and no ready message. README.md:275 refers to a hello and welcome handshake and README.md:301 says the negotiated protocol version appears in session.hello, while the shipped handshake uses session.open, optional session.challenge and session.authenticate, and session.accepted. docs/guides/subscriptions.md:50 says backfill completion is an event.emit, but the implementation sends a subscribe.event whose JSON body contains subscription.backfill_complete. docs/recipes.md:32 references JobContext.heartbeat() and docs/recipes.md:15 says LeaseConstraints has costBudget and modelUse fields, none of which exists. README.md:31 and docs/getting-started.md:6 claim Linux support even though Package.swift:11 declares only macOS 14 and the library imports Apple CryptoKit.

Fix prompt: Do a documentation pass that reconciles README, CONFORMANCE.md, docs guides, recipe docs, and source comments with the current public API and runtime behavior. Remove obsolete phase language, use the actual message names, update feature support tables, correct nonexistent APIs and fields, and either document Linux as unsupported or make the package and crypto dependency story genuinely cross-platform. Add a lightweight docs validation checklist to release work so conformance and guide text are updated when protocol surfaces change.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationseverity:mediumMedium severity issue

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions