docs: add missing READMEs for sacp-tee, sacp-test, and yopo crates#64
Closed
koriyoshi2041 wants to merge 1 commit intoagentclientprotocol:mainfrom
Closed
docs: add missing READMEs for sacp-tee, sacp-test, and yopo crates#64koriyoshi2041 wants to merge 1 commit intoagentclientprotocol:mainfrom
koriyoshi2041 wants to merge 1 commit intoagentclientprotocol:mainfrom
Conversation
These three crates were missing README files, making it harder for new contributors to understand their purpose and usage. - sacp-tee: Debugging proxy that logs all ACP traffic to a file - sacp-test: Test utilities and mock types for testing ACP agents - yopo: Simple one-shot ACP client for quick testing Each README follows the same structure as existing crate READMEs (sacp-tokio, sacp-proxy) with sections for description, usage examples, and related crates.
Member
|
We're going to resync these from newer versions later. removed for now |
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
2 participants
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
Adds README files for three crates that currently lack documentation:
Each README documents the crate's purpose, key types/functions, and usage examples. Content was cross-referenced against the source code for accuracy. Style follows the existing READMEs in
sacp-proxy/andelizacp/.Changes
src/sacp-tee/README.md(new)src/sacp-test/README.md(new)src/yopo/README.md(new)