Skip to content

docs: update package READMEs with accurate usage examples#470

Merged
khaliqgant merged 1 commit intomainfrom
docs/update-package-readmes
Mar 2, 2026
Merged

docs: update package READMEs with accurate usage examples#470
khaliqgant merged 1 commit intomainfrom
docs/update-package-readmes

Conversation

@khaliqgant
Copy link
Copy Markdown
Member

@khaliqgant khaliqgant commented Mar 2, 2026

Summary

  • @agent-relay/sdk: Rewrote to highlight the workflow builder API as the primary usage pattern, documented the AgentRelay high-level facade, added subpath exports section, and added workflow templates section
  • agent-relay (Python SDK): Cleaned up structure, added event types table, documented configuration export methods (to_config, to_yaml)
  • @agent-relay/acp-bridge: Simplified structure, added CLI options table, streamlined Zed integration instructions

Test plan

  • Verified README content matches actual API implementations
  • Code examples are syntactically correct
  • Review for any additional improvements

🤖 Generated with Claude Code


Open with Devin

- @agent-relay/sdk: Highlight workflow builder API as primary usage,
  document AgentRelay facade, add subpath exports and templates sections
- agent-relay (Python): Clean up structure, add event types table,
  document configuration export methods
- @agent-relay/acp-bridge: Simplify structure, add CLI options table,
  streamline Zed integration instructions

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@khaliqgant khaliqgant requested a review from willwashburn as a code owner March 2, 2026 11:05
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 5 additional findings.

Open in Devin Review

@khaliqgant khaliqgant merged commit c1e3102 into main Mar 2, 2026
32 of 33 checks passed
@khaliqgant khaliqgant deleted the docs/update-package-readmes branch March 2, 2026 12:39
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