docs(libsy): update readme / quickstart - #153
Conversation
Signed-off-by: Greg Clark <grclark@nvidia.com>
WalkthroughThe README updates ChangesAPI and routing documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@crates/libsy/README.md`:
- Line 380: Update the earlier LlmClassifier example comment describing Context
to remove the stale claim that correlation IDs and budgets are already carried,
keeping it consistent with the current Context fields documented nearby.
- Around line 201-214: Update the README quickstart’s trait-object guidance to
use Arc<dyn Algorithm<S>> so it supports stateful implementations such as
FallThrough with SharedState, while retaining the existing stateless
Algorithm<()> usage where appropriate.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 0c562fc7-c02d-4830-b2da-01920e50994e
📒 Files selected for processing (1)
crates/libsy/README.md
What
update libsy reame
Why
The motivation — what problem does this solve, or which ticket does it close?
Closes #
How tested
uv run ruff check .cleanuv run mypy switchyardcleanuv run pytest tests/greenChecklist
snake_caseof the primary class.switchyard/__init__.py.__all__if intended for downstream use.--helpupdated if customer-facing surface changed.Signed-off-by: Your Name <email>) per the DCO.Notes for reviewers
Anything reviewers should pay extra attention to — risky paths, follow-up tickets, intentional trade-offs.
Summary by CodeRabbit
FallThroughrouter and its processor/classifier building blocks.FallThroughandSubagentOverride.