Skip to content

Build out README and 10 conceptual guides #28

@nficano

Description

@nficano

README is currently minimal; conformance.md is 2 lines. Build out documentation to match TS SDK depth.

Steps:

  1. Rewrite README.md with: badge linking to draft-arcp-02.1.md, install snippet, quickstart, package layout, link to docs
  2. Create docs/guides/{auth,delegation,errors,job-events,jobs,leases,observability,resume,sessions,vendor-extensions}.md (mirror typescript-sdk/docs/guides/)
  3. Create docs/architecture.md, docs/conformance.md (proper version with section-by-section coverage), docs/getting-started.md, docs/transports.md, docs/troubleshooting.md

Audit reference: ARCP SDK Audit v1.1 (2026-05-19)

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation

    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