docs: added examples and improved READMEs#15
Merged
deadcode-walker merged 4 commits intomainfrom Mar 20, 2026
Merged
Conversation
…port, and PBX examples New examples demonstrating previously uncovered features: - ami_call_tracker: CallTracker for correlating AMI events into CompletedCall records - agi_ivr: realistic IVR menu with DTMF, AstDB, variables, branching logic - ari_recording: channel recording and playback with filtered event subscription - ari_pending: race-free origination via PendingChannel factory - ari_websocket_transport: unified WebSocket transport mode with REST and events - pbx_dial: high-level Pbx abstraction for dial, wait_for_answer, hangup, CDR Added tracing and tracing-subscriber dev-dependencies to umbrella crate for pbx_dial example.
…coverage Root README: - fixed version numbers (0.1 umbrella, 0.4 AMI, 0.2 AGI, 0.4 ARI) - fixed missing .await on recv() in quick example - added feature selection section with default-features=false - added call tracker, PBX, pending resources, transport modes, outbound WS, media channel to capabilities - added four new example snippets (call tracker, AGI IVR, ARI pending, PBX dial) - fixed AGI handler signature to use native async fn (not Pin<Box<dyn Future>>) - fixed ARI imports to use actual module paths Core README: - expanded from 16 to 62 lines - listed all error types, event bus types, reconnect policy, credentials, and domain constant enums AMI README: - added call tracker section with example - added builder options table with correct defaults - fixed ReconnectPolicy import path to asterisk_rs_core::config - fixed timeout default (30s not 10s), ping_interval default (disabled) AGI README: - added available commands section organized by category (7 tables) - expanded capabilities with command count and hangup detection ARI README: - fixed AriConfig::builder() to AriConfigBuilder::new() - added transport modes, race-free resource creation, resource handles, outbound WebSocket server, and media channel sections - expanded capabilities list
github-actions
bot
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Added 6 new examples demonstrating previously uncovered features and rewrote all 5 READMEs with accurate APIs, correct version numbers, and full feature coverage.
New examples
ami_call_tracker.rsagi_ivr.rsari_recording.rsari_pending.rsari_websocket_transport.rspbx_dial.rsREADME fixes
.await, fixed AGI handler signature, added feature selection, call tracker, PBX, pending resources, transport modes to capabilities, added 4 example snippetsAriConfig::builder()toAriConfigBuilder::new(), added transport modes, pending resources, resource handles, outbound WS server, media channel sectionsOther