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.
Current state (rust-sdk)
docs/ contains only diagrams — no markdown pages.
This SDK ships a single crate (arcp) with both lib and bin targets. Not a Cargo workspace.
Sub-modules under src/: auth, client, runtime, transport, store, messages, extensions (these are implementation modules, not separately-published crates).
N/A — no subdirectory. This SDK has one crate, so there is nothing to mirror. Document the public module surface inside docs/architecture.md (linking out to docs.rs for symbol-level reference) and in the relevant guides; do not invent a docs/crates/ or docs/modules/ directory just to fill a slot.
If this ever becomes a Cargo workspace with multiple published crates, add docs/crates/ then. Feature flags (transport-ws, transport-stdio) belong in a Features section of docs/architecture.md.
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 go-sdk docs/ for systems-language content patterns, but copy the conceptual layout from TypeScript SDK.
For idiomatic Rust API docs, rely on rustdoc (cargo doc) for symbol-level reference; docs/ pages should be narrative, not exhaustive API dumps.
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
Closes / supersedes
Subsumes Build out README and CONFORMANCE #39 (README + CONFORMANCE) — covers both the docs/ buildout and ensures README/CONFORMANCE link into it
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 (rust-sdk)
docs/contains only diagrams — no markdown pages.arcp) with both lib and bin targets. Not a Cargo workspace.src/: auth, client, runtime, transport, store, messages, extensions (these are implementation modules, not separately-published crates).Target structure
Per-source-unit pages
N/A — no subdirectory. This SDK has one crate, so there is nothing to mirror. Document the public module surface inside
docs/architecture.md(linking out to docs.rs for symbol-level reference) and in the relevant guides; do not invent adocs/crates/ordocs/modules/directory just to fill a slot.If this ever becomes a Cargo workspace with multiple published crates, add
docs/crates/then. Feature flags (transport-ws,transport-stdio) belong in a Features section ofdocs/architecture.md.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 go-sdk
docs/for systems-language content patterns, but copy the conceptual layout from TypeScript SDK.For idiomatic Rust API docs, rely on rustdoc (
cargo doc) for symbol-level reference;docs/pages should be narrative, not exhaustive API dumps.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