You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Align this SDK's docs/ directory with the canonical layout used by the TypeScript SDK. The conceptual pages (getting-started, architecture, transports, guides, etc.) are identical across every SDK. The per-source-unit subdirectory adapts to whatever the language calls its organizational unit — and only exists if this SDK actually has multiple such units.
The TS SDK uses docs/packages/ because it is a TypeScript monorepo with multiple npm packages. Do not blindly copy that name. If this SDK has multiple .NET projects, use docs/projects/. Multiple Gradle modules → docs/modules/. Multiple SwiftPM targets → docs/targets/. One single artifact → omit the subdirectory entirely — there is nothing to mirror.
The TS docs/README.md shape (Start here / Guides / Packages / Reference / Diagrams) is the index template — replace its "Packages" section with whatever this SDK's source-unit name is, or remove it if this SDK has only one artifact.
Inside Sources/ARCP: Auth, Client, Envelope, Errors, Extensions, Ids, Messages, Runtime, Store, Trace, Transport (these are folders inside one target, not separate targets).
Two SwiftPM targets → docs/targets/ (SwiftPM's native term):
docs/targets/
├── ARCP.md # `ARCP` library target — sub-headings per Swift folder (Client / Runtime / Transport / Auth / Messages / Store / Trace / Extensions)
└── arcp-cli.md # the `arcp-cli` executable target
For idiomatic Swift API docs, rely on DocC for symbol-level reference; docs/targets/ARCP.md is a narrative overview that links out to the DocC archive, not an exhaustive API dump.
Authoring rules
Guides are spec-aligned, not feature-aligned. If the SDK currently has features/heartbeat.md, features/ack.md, etc., fold them into guides/job-events.md. If it has features/cost-budget.md, fold into guides/jobs.md (or its own guides/budgets.md only if it would otherwise be >2 screens).
docs/README.md is the index. Four sections (or three if no multi-artifact split): Start here, Guides, (if applicable), Reference. No content lives only in the index.
Diagrams use <picture> with prefers-color-scheme and ship both light + dark SVGs. Reference the architecture diagram from docs/README.md and docs/architecture.md.
Spec links point at ../../spec/docs/draft-arcp-1.1.md#section so they survive renames.
No orphan pages. Anything not linked from docs/README.md must be deleted or linked.
CONFORMANCE.md at repo root stays authoritative; docs/conformance.md summarizes + links to it.
Note
Starting effectively from scratch (only diagrams exist). Build out the entire target structure. Refer to kotlin-sdk docs/ once that issue lands as a close peer (similar two-artifact shape), but copy the conceptual layout from TypeScript SDK.
Acceptance
Every conceptual file in the target structure exists (except cli.md if this SDK truly has no CLI — note the omission in docs/README.md)
docs/README.md matches the four-section shape of TS docs/README.md, substituting this SDK's source-unit term (or omitting that section entirely if single-artifact)
Every page is linked from docs/README.md; no orphans
Old feature-shaped pages (features/*, concepts/*, numeric NN-*.md) deleted or merged into canonical pages
Diagrams use <picture> light/dark and render on GitHub
Goal
Align this SDK's
docs/directory with the canonical layout used by the TypeScript SDK. The conceptual pages (getting-started,architecture,transports, guides, etc.) are identical across every SDK. The per-source-unit subdirectory adapts to whatever the language calls its organizational unit — and only exists if this SDK actually has multiple such units.The TS SDK uses
docs/packages/because it is a TypeScript monorepo with multiple npm packages. Do not blindly copy that name. If this SDK has multiple .NET projects, usedocs/projects/. Multiple Gradle modules →docs/modules/. Multiple SwiftPM targets →docs/targets/. One single artifact → omit the subdirectory entirely — there is nothing to mirror.The TS
docs/README.mdshape (Start here / Guides / Packages / Reference / Diagrams) is the index template — replace its "Packages" section with whatever this SDK's source-unit name is, or remove it if this SDK has only one artifact.Current state (swift-sdk)
docs/contains only diagrams — no markdown pages.ARCPlibrary target +arcp-cliexecutable target.Sources/ARCP: Auth, Client, Envelope, Errors, Extensions, Ids, Messages, Runtime, Store, Trace, Transport (these are folders inside one target, not separate targets).Target structure
Per-source-unit pages
Two SwiftPM targets →
docs/targets/(SwiftPM's native term):For idiomatic Swift API docs, rely on DocC for symbol-level reference;
docs/targets/ARCP.mdis a narrative overview that links out to the DocC archive, not an exhaustive API dump.Authoring rules
features/heartbeat.md,features/ack.md, etc., fold them intoguides/job-events.md. If it hasfeatures/cost-budget.md, fold intoguides/jobs.md(or its ownguides/budgets.mdonly if it would otherwise be >2 screens).docs/README.mdis the index. Four sections (or three if no multi-artifact split): Start here, Guides, (if applicable), Reference. No content lives only in the index.<picture>withprefers-color-schemeand ship both light + dark SVGs. Reference the architecture diagram fromdocs/README.mdanddocs/architecture.md.../../spec/docs/draft-arcp-1.1.md#sectionso they survive renames.docs/README.mdmust be deleted or linked.CONFORMANCE.mdat repo root stays authoritative;docs/conformance.mdsummarizes + links to it.Note
Starting effectively from scratch (only diagrams exist). Build out the entire target structure. Refer to kotlin-sdk
docs/once that issue lands as a close peer (similar two-artifact shape), but copy the conceptual layout from TypeScript SDK.Acceptance
cli.mdif this SDK truly has no CLI — note the omission indocs/README.md)docs/README.mdmatches the four-section shape of TSdocs/README.md, substituting this SDK's source-unit term (or omitting that section entirely if single-artifact)docs/README.md; no orphansfeatures/*,concepts/*, numericNN-*.md) deleted or merged into canonical pages<picture>light/dark and render on GitHubCloses / supersedes
Reference
docs/README.md(index shape to copy, minus the language-specific "Packages" wording): https://github.com/agentruntimecontrolprotocol/typescript-sdk/blob/main/docs/README.md../spec/docs/draft-arcp-1.1.md