Skip to content

docs: add API documentation for Phase 2 features#8

Merged
bkataru merged 1 commit intomasterfrom
docs/api-design-phase2
Feb 1, 2026
Merged

docs: add API documentation for Phase 2 features#8
bkataru merged 1 commit intomasterfrom
docs/api-design-phase2

Conversation

@bkataru
Copy link
Member

@bkataru bkataru commented Feb 1, 2026

Summary

  • Adds comprehensive API documentation for the Phase 2 features introduced in v0.3.0

Documentation Added

SkillExecutor Trait

  • Full trait definition with execute() and execute_step() methods
  • DefaultSkillExecutor usage examples with configuration options

ExecutionHooks

  • Complete trait definition for lifecycle callbacks
  • Built-in implementations: NoOpHooks, TracingHooks, CompositeHooks

Session Management

  • Session struct for managing multi-turn workflows
  • SessionEntry types (UserMessage, AssistantMessage, ToolCall, ToolResult)
  • SessionManager for persistent session storage
  • Configuration options (max turns, TTL)

Timeout & Retry Configuration

  • TimeoutConfig and RetryConfig structs
  • Per-step timeout and retry overrides
  • Retry strategies (fixed, exponential)

SKILL.md Parsing

  • Frontmatter format specification
  • Example skill file structure
  • SkillLoader usage for loading skills from filesystem

Add documentation for:
- SkillExecutor trait and DefaultSkillExecutor
- ExecutionHooks trait with built-in implementations
- Session management (Session, SessionEntry, SessionManager)
- Timeout and retry configuration
- SKILL.md file format parsing
@bkataru bkataru merged commit 8c05691 into master Feb 1, 2026
10 checks passed
@bkataru bkataru deleted the docs/api-design-phase2 branch February 1, 2026 06:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant