docs: refresh README to reflect shipped 0.4.x surface - #24
Merged
Conversation
- Bump documented crate version 0.4.0 -> 0.4.2 and replace the 'Current Unreleased work' sentence with a summary of what the 0.4.x line actually shipped (budget module, dispatch hooks, context packs, bounded tool results, retry classification, repair_history, DispatchTrace recording). - Document the previously-missing public symbols in Key Types: ToolDispatchAction, ToolDispatchHook, RetryClass, RetryClassifier, DefaultRetryClassifier, ToolCallFingerprint, HistoryEntry, repair_history, DispatchTrace, DispatchTraceEvent, TracedAction, TracedOutcome, bound_tool_result, ContextOmissionReason, and OmittedContextItem.
Merged
There was a problem hiding this comment.
Pull request overview
Documentation-only refresh of the README to align with the shipped 0.4.x public surface. Updates the documented crate version to 0.4.2, replaces the stale "Current Unreleased work" paragraph with a description of what 0.4.x actually shipped, and extends the Key Types section to list previously-undocumented public symbols (retry classification, dispatch tracing, dispatch hooks, repair history, context omission types, and bound_tool_result).
Changes:
- Bump documented crate version
0.4.0→0.4.2and rewrite the status bullet to describe the 0.4.x release line, pointing toCHANGELOG.md. - Expand the
src/normalizer.rsKey Types bullet to mentionToolDispatchActionandToolDispatchHookand the hook capabilities. - Add new Key Types entries for
src/reliability.rs,src/trace.rs,src/tool.rs::bound_tool_result, andsrc/context.rsomission audit types.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - [src/normalizer.rs](src/normalizer.rs): `ToolCallNormalizer`, `LfmNormalizer`, `StructuredToolCallNormalizer`, `ToolInvocation`, `ToolInvocationResult`, `BoundedToolInvocationResult`, and the dispatch helpers. These normalize LFM/MLX text markers, OpenAI Responses `function_call` output, and OpenAI Chat Completions `tool_calls` into the same dispatchable shape. | ||
| - [src/normalizer.rs](src/normalizer.rs): `ToolCallNormalizer`, `LfmNormalizer`, `StructuredToolCallNormalizer`, `ToolInvocation`, `ToolInvocationResult`, `BoundedToolInvocationResult`, `ToolDispatchAction`, `ToolDispatchHook`, and the dispatch helpers. These normalize LFM/MLX text markers, OpenAI Responses `function_call` output, and OpenAI Chat Completions `tool_calls` into the same dispatchable shape, and let callers veto, skip, or terminate dispatches via hooks. | ||
| - [src/reliability.rs](src/reliability.rs): `RetryClass`, `RetryClassifier`, `DefaultRetryClassifier`, `ToolCallFingerprint`, `HistoryEntry`, and `repair_history` for classifying tool-call failures, building deterministic invocation fingerprints, and rewriting model history so retries replace prior failed attempts instead of stacking. | ||
| - [src/trace.rs](src/trace.rs): `DispatchTrace`, `DispatchTraceEvent`, `TracedAction`, and `TracedOutcome` — the per-dispatch trace recorder consumed by `dispatch_normalized_traced` for auditing hook decisions, reservation outcomes, repairs, and final tool results. |
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
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.
Documentation-only update.
0.4.0->0.4.2and replace the 'Current Unreleased work' sentence with a summary of what the 0.4.x line actually shipped (budget module, dispatch hooks, context packs, bounded tool results, retry classification,repair_history,DispatchTracerecording).ToolDispatchAction,ToolDispatchHook,RetryClass,RetryClassifier,DefaultRetryClassifier,ToolCallFingerprint,HistoryEntry,repair_history,DispatchTrace,DispatchTraceEvent,TracedAction,TracedOutcome,bound_tool_result,ContextOmissionReason, andOmittedContextItem.No code changes. Caught during the cross-crate doc audit.