Skip to content

docs: README accuracy and structure pass - #1

Closed
embeddinglayer wants to merge 1 commit into
mainfrom
docs/readme-polish
Closed

embeddinglayer wants to merge 1 commit into
mainfrom
docs/readme-polish

Conversation

@embeddinglayer

Copy link
Copy Markdown
Contributor

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

  • Sections reordered and renamed to the shared layout: Installation, Quick start, Authentication, IP and domain lookups, Account, Feeds, Errors, Retries and timeouts, Configuration, Response metadata, gRPC schema, Requirements, Versioning, Documentation, Contributions, License.
  • "API Keys" and "Authentication" merged; "Streaming", "Pagination" (now "Exports") and "Downloads" moved under Feeds with the feed table; "Server Selection" and "Custom HTTP Client" moved under Configuration; "Debugging" is now "Response metadata"; "Maturity" is now "Versioning".
  • The method index stays in "Available Resources and Operations". Its second heading is now "Feed", so #feeds resolves to the Feeds section.

Fixes

  • Snippets that used Duration, Ipv4Addr or an un-annotated parse() now carry their use lines and types.

Additions (all from the source)

  • Lookups: an IPv6 example reading network and location; lookup_ips behaviour for an empty slice and for more than 1000 addresses (src/lookup.rs); Timestamp::to_system_time (src/timestamp.rs).
  • Account: health (src/account.rs).
  • Downloads: Download::content_length (src/feed.rs).
  • Retries: backoff from one second up to 30 seconds with 25% jitter, and the one-minute Retry-After ceiling (src/retry.rs); streams' 15-second keepalive (src/lib.rs).
  • Configuration: a table of the ClientBuilder options and defaults, DEFAULT_BASE_URL, VERSION, base URL validation, and the User-Agent prefix (src/client.rs).
  • Response metadata: RateLimit fields, and that the hook is not called for storage-host responses (src/response.rs, src/client.rs).
  • gRPC schema: the Fetch options endpoint, plaintext, symbols, timeout and their defaults (src/grpcschema.rs).
  • Links from each section to the matching page on docs.synthient.com.

Not verified

  • Nothing was compiled or run; the examples were checked by reading the source only.
  • Server-side behaviour the README already described (30-minute stream close, 00:30 UTC rollup, credit pricing, status-code meanings) is taken from the crate's doc comments, not tested against the API.

Copilot AI balanced review requested due to automatic review settings November 15, 2026 22:32

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@embeddinglayer
embeddinglayer deleted the docs/readme-polish branch November 15, 2026 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants