Skip to content

docs: update documentation structure, add integrations and skills #6

Merged
BestOwl merged 12 commits intocorespeed-io:masterfrom
jiweiyuan:update-docs-20260129
Feb 8, 2026
Merged

docs: update documentation structure, add integrations and skills #6
BestOwl merged 12 commits intocorespeed-io:masterfrom
jiweiyuan:update-docs-20260129

Conversation

@jiweiyuan
Copy link
Copy Markdown
Contributor

Summary

  • Add Cloudflare AI Gateway integration and update LLM model versions
  • Rewrite loop interceptors with simplified factory function API (continueOnMaxTokens(), errorDetector())
  • Introduce createZypherAgent factory as the recommended approach in quick start
  • Add new documentation sections: Skills and Integrations (ACP, HTTP)
  • Standardize doc structure by moving introductions to frontmatter descriptions

Changes

New Documentation

  • Skills - Guide for creating reusable agent workflows and custom commands
  • Integrations - ACP (Agent Communication Protocol) and HTTP server integration guides

Updated Documentation

  • LLM Providers - Cloudflare AI Gateway support, updated Anthropic/OpenAI models
  • Loop Interceptors - Simplified API with factory functions, multi-language examples
  • Quick Start - New createZypherAgent factory pattern

Structural Improvements

  • Move introduction text to frontmatter descriptions across all docs
  • Remove redundant H1 headers
  • Use Card component for navigation in examples

Add .vscode to gitignore and update bun.lock with configVersion.
- Add Cloudflare AI Gateway integration section with example
- Update Anthropic models: add claude-sonnet-4-5, remove claude-3-haiku
- Update OpenAI models: add gpt-5.2, o4, reorganize reasoning models
- Move introduction to frontmatter description
- Remove redundant H1 header
Rewrite loop interceptors documentation to use the new simplified API:

- Replace class-based MaxTokensInterceptor with continueOnMaxTokens()
- Replace ErrorDetectionInterceptor with errorDetector(command, args)
- Remove ToolExecutionInterceptor (now automatic)
- Add examples for multiple languages (Deno, Node, Python, Rust, Go)
- Simplify custom interceptor examples with factory functions
- Update InterceptorResult to use { complete, reason } pattern
- Add combining interceptors example
- Add createZypherAgent as the recommended approach
- Move manual setup to collapsible "Alternative" section
- Update model to claude-sonnet-4-5-20250929
- Improve event streaming example with proper stdout writing
- Simplify code by removing getRequiredEnv helper
- Move introduction to frontmatter description
- Move introduction text to frontmatter descriptions
- Remove redundant H1 headers from all tools docs
- Move introduction text to frontmatter description
- Remove redundant H1 header
- Replace markdown link with Card component
- Move introduction to frontmatter description
Add new skills documentation explaining how to create and use
agent skills for reusable workflows and custom commands.
Add new integrations documentation section:
- ACP (Agent Communication Protocol) integration guide
- HTTP server integration for web applications
- Index page with integration overview
Remove verbose multi-language examples, keep only Deno example.
- Fix continueOnMaxTokens to take number directly, not options object
- Remove incorrect toolApprovalHandler docs (not in createZypherAgent API)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants