Repository navigation
docs: README accuracy and structure pass - #1
Closed
embeddinglayer wants to merge 1 commit into
Closed
embeddinglayer wants to merge 1 commit into
embeddinglayer wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Note
Copilot was unable to complete this review at the selected tier due to model policy or plan restrictions.
🟢 Approval recommended
The review evidence describes only documentation restructuring and example updates to reflect the current Rust SDK API and behaviors, with no unresolved issues or risks noted, supporting approval.
No open issues 🎉
What changed in this PR
Aligns and restructures the Rust SDK README to match the shared SDK documentation layout, updating examples and narrative details to reflect the current API surface area.
Changes:
- Reorganized sections and Table of Contents to the standard SDK README structure and updated anchors accordingly.
- Corrected and expanded code snippets to be more self-contained (imports, explicit types) and added examples/notes for additional SDK behaviors.
- Documented configuration defaults and runtime behaviors (retries/timeouts, response metadata, gRPC schema fetch options) and added links to corresponding docs pages.
| File | Description |
|---|---|
| README.md | Restructures and updates the README to match the shared SDK layout while correcting/expanding examples and documenting current SDK behaviors and defaults. |
Review effort: Balanced
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.
Brings the README in line with the other SDK READMEs. Every claim and example was checked against the source; existing wording is kept wherever it was already correct.
Structure
#feedsresolves to the Feeds section.Fixes
Duration,Ipv4Addror an un-annotatedparse()now carry theiruselines and types.Additions (all from the source)
networkandlocation;lookup_ipsbehaviour for an empty slice and for more than 1000 addresses (src/lookup.rs);Timestamp::to_system_time(src/timestamp.rs).health(src/account.rs).Download::content_length(src/feed.rs).Retry-Afterceiling (src/retry.rs); streams' 15-second keepalive (src/lib.rs).ClientBuilderoptions and defaults,DEFAULT_BASE_URL,VERSION, base URL validation, and theUser-Agentprefix (src/client.rs).RateLimitfields, and that the hook is not called for storage-host responses (src/response.rs,src/client.rs).Fetchoptionsendpoint,plaintext,symbols,timeoutand their defaults (src/grpcschema.rs).Not verified