Add TypeScript client quickstart and configuration reference#25
Merged
Add TypeScript client quickstart and configuration reference#25
Conversation
- Add TypeScript client quickstart (withCycles, reserveForStream, CyclesClient) - Add TypeScript client configuration reference - Reorder sidebar: integration guides first (Python, TypeScript, Spring Boot), ops guides after (architecture, deploy, self-hosting) - Update homepage CTA to point to Python quickstart instead of deployment - Add runaway demo reference and run instructions to incidents page - Add TypeScript to homepage features description and incidents next steps https://claude.ai/code/session_01G5yRZBXrczLDVtrHzCZWdu
- Update architecture diagram to show Spring, Python, Node.js, and HTTP agents - Add TypeScript section to Deploy the Full Stack "Connect your application" - Replace external GitHub Python client links with internal doc links across all 29 pages (concepts, protocol, how-to, quickstart) - Add TypeScript client link to Next steps on every page https://claude.ai/code/session_01G5yRZBXrczLDVtrHzCZWdu
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
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.
Summary
This PR adds comprehensive documentation for the TypeScript/Node.js client library (
runcycles), including a complete quickstart guide and configuration reference. It also updates navigation to surface the Python client quickstart as the primary entry point and adds a reference to the runaway agent demo in the incidents documentation.Key Changes
New quickstart guide (
getting-started-with-the-typescript-client.md): Complete walkthrough covering:withCycleshigher-order function with fixed and dynamic estimatesgetCyclesContext()reserveForStreamCyclesClientusage with wire format mappersNew configuration reference (
typescript-client-configuration-reference.md): Detailed reference for:CyclesConfigconstructor options (required fields, subject defaults, HTTP timeouts)Updated navigation (
.vitepress/config.tsandindex.md):Enhanced incidents documentation (
runaway-agents-tool-loops-and-budget-overruns-the-incidents-cycles-is-designed-to-prevent.md):Notable Implementation Details
withCyclesHOF (simplest),reserveForStream(streaming), andCyclesClient(full control)https://claude.ai/code/session_01G5yRZBXrczLDVtrHzCZWdu