Skip to content

docs(sdk): add runnable examples and tighten README quick start - #185

Merged
undivisible merged 1 commit into
mainfrom
chore/sdk-ergonomics-rotary
Sep 11, 2026
Merged

undivisible merged 1 commit into
mainfrom
chore/sdk-ergonomics-rotary

Conversation

@undivisible

@undivisible undivisible commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

SDK ergonomics pass for the rx4 embed surface.

  • README: Quick start now leads with library cargo add and the gated binary cargo install before the capability list; repaired the malformed Docs section.
  • examples/: new minimal_agent, custom_tool, sessions, and provider_agent (requires providers) plus an equilibrium-style examples/README.md.
  • AGENTS.md: fixed stale praefectus version (0.4.1 -> 0.8.0), corrected the tool loadout description, added zkr-memory/personality rows.

Validation run locally:

  • cargo build --examples
  • cargo build --example provider_agent --features providers
  • cargo run --example minimal_agent / custom_tool / sessions
  • cargo clippy --examples --features providers
  • cargo fmt --check

Note

Low Risk
Documentation and example-only changes with no runtime or security behavior changes.

Overview
SDK ergonomics for library hosts: the README now leads with library cargo add, an updated embed snippet (Policy::workspace_write, pointer to provider_agent), runnable example commands, a gated-binary install section, a What it exposes capability list, and a cleaned-up docs index.

New examples/: four small programs (minimal_agent, custom_tool, sessions, provider_agent) plus examples/README.md with run instructions; Cargo.toml declares provider_agent with required-features = ["providers"].

AGENTS.md housekeeping: praefectus 0.4.1 → 0.8.0, expanded builtin tool loadout description, and feature-table rows for zkr-memory and personality.

Reviewed by Cursor Bugbot for commit dfc9923. Configure here.

Add examples/ with minimal_agent, custom_tool, sessions, and provider_agent
plus an equilibrium-style examples/README. Move library cargo add and
gated binary cargo install into Quick start before the capability list.
Fix malformed Docs section and stale AGENTS.md praefectus version.
@cursor

cursor Bot commented Sep 11, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: serverGenReqId_595ea906-e308-4d3d-9313-f0ab64ca5ff3)

@undivisible
undivisible merged commit 06c35b2 into main Sep 11, 2026
3 checks passed
@undivisible
undivisible deleted the chore/sdk-ergonomics-rotary branch September 11, 2026 19:25
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