Close #16 #17 #18 #19: docs cleanup, recipes, samples, contributing#21
Merged
Conversation
- Add docs/README.md: index with Start here, Guides, Diagrams, Conformance - Add docs/conformance.md: pointer to root CONFORMANCE.md - Rewrite docs/getting-started.md: merge quickstart full script + ECHO_HANDLER, 'What you should see' block, update Next links to new guide paths - Update docs/architecture.md: add Capabilities section (Feature constants, negotiation, checking features) and Agent versioning section from deleted standalone guides; fix spec frontmatter kind - Add docs/guides/sessions.md (merged from concepts/sessions.md + reference/capabilities.md) - Add docs/guides/auth.md (merged from concepts/auth.md) - Add docs/guides/resume.md (merged from concepts/resume.md + concepts/heartbeats.md) - Add docs/guides/jobs.md (merged from concepts/jobs.md + guides/budgets.md) - Add docs/guides/job-events.md (merged from concepts/events.md + concepts/subscribe.md + guides/result-streaming.md) - Add docs/guides/leases.md (merged from concepts/leases.md) - Add docs/guides/delegation.md (merged from concepts/delegation.md) - Add docs/guides/errors.md (merged from reference/errors.md) - Add docs/guides/vendor-extensions.md (merged from concepts/vendor-extensions.md) - Delete docs/concepts/ (10 files merged into guides/) - Delete docs/guides/quickstart.md, budgets.md, result-streaming.md, agent-versioning.md (content merged into getting-started.md / jobs.md / job-events.md / architecture.md) - Delete docs/reference/ (capabilities.md, errors.md, conformance.md merged or replaced) - Update docs/README.md diagram table to reference actual SVG files Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This was referenced May 22, 2026
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
1 participant
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.
Resolves #16, resolves #17, resolves #18, resolves #19.
Issue #16 — Expand
docs/recipes.mdwith 4 missing TS canonical recipesAdded four new complete, runnable recipes:
email-vendor-leasesInMemoryProvisioner+ lease-scoped credential, auto-revoked on terminationmcp-skillmulti-agent-budgetSubsetting.boundstream-resumeresume_token+last_event_seq, reassembling chunks across a reconnectIssue #17 — Create
samples/README.mdNew
samples/README.mddocuments why the Ruby SDK ships no sample scripts (single-fileMemoryTransportusage is idiomatic; all patterns live indocs/recipes.mdandspec/integration/) and points to the integration tests.Issue #18 — Create
CONTRIBUTING.mdNew
CONTRIBUTING.mdcovering:Data.define, keyword args, nounless…else, Comparable, Enumerable)bundle exec rake spec,bundle exec rake spec:integration)spec/support/helpers and transport pair patternIssue #19 — Align
docs/structure with TS SDKNew files
docs/README.mddocs/conformance.mdCONFORMANCE.mddocs/guides/sessions.mdconcepts/sessions.md+reference/capabilities.mddocs/guides/auth.mdconcepts/auth.mddocs/guides/resume.mdconcepts/resume.md+concepts/heartbeats.mddocs/guides/jobs.mdconcepts/jobs.md+guides/budgets.mddocs/guides/job-events.mdconcepts/events.md+concepts/subscribe.md+guides/result-streaming.mddocs/guides/leases.mdconcepts/leases.mddocs/guides/delegation.mdconcepts/delegation.mddocs/guides/errors.mdreference/errors.mddocs/guides/vendor-extensions.mdconcepts/vendor-extensions.mdUpdated files
docs/getting-started.md— merged full quickstart script (ECHO_HANDLER, "What you should see"), updated Next links to new guide pathsdocs/architecture.md— added Capabilities section (Feature constants, negotiation, checking features) and Agent versioning section; updated diagram table to SVGsDeleted
docs/concepts/(all 10 files — merged into guides)docs/guides/quickstart.md,budgets.md,result-streaming.md,agent-versioning.md(merged into getting-started / jobs / job-events / architecture)docs/reference/capabilities.md,errors.md,conformance.md(merged or replaced)🤖 Generated with Claude Code