Skip to content

docs: README accuracy and structure pass - #8

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

Checked every claim and example in the README against the source in lib/ and the gemspec. Nothing in it was wrong, so this is a structure and completeness pass that keeps the existing wording.

Structure

  • Sections now follow the order shared by the other SDK READMEs: Installation, Quick Start, Authentication, IP and Domain Lookups, Account, Feeds, Error Handling, Retries and Timeouts, Configuration, Response Metadata, gRPC Schema, Requirements, Versioning, Documentation, License.
  • "API Keys" and "Authentication" are one section; "Retries" and "Timeouts" are one section; "Server Selection" and "Custom HTTP Client" sit under Configuration; "Debugging" is now "Response Metadata"; "Maturity" is now "Versioning".
  • The feed table moved from the method list into the Feeds section, with Streaming, Pagination and Downloads beneath it. Its rows are unchanged.
  • The second method list is headed "Feed" (the class name), so #feeds points at the Feeds section.

Added (each verified against the source)

  • Client options table with defaults (Client#initialize).
  • health example and close in the method list (client.rb).
  • Input rules for the lookups: prefix/zone addresses, empty and over-1000 batches, the limit: defaults (client.rb).
  • Synthient::Scope constants for checking account.scopes (models/account.rb).
  • list_exports / each_export limit: and cursor:, string export ID forms, the download enumerator, and a checksum verification example (feed.rb).
  • A Retry-After longer than 60 seconds is raised instead of retried (transport.rb, MAX_RETRY_AFTER).
  • ResponseMetadata and RateLimit attributes, and that storage downloads are not reported to the hook (response_metadata.rb).
  • GRPCSchema.fetch options (grpcschema.rb).
  • Forked processes never reuse inherited connections (transport.rb).
  • Links from each section to the matching page on docs.synthient.com, and a Documentation section.

Not verifiable from this repository

  • Server behaviour the README already described: the 30-minute stream lifetime, the 15-second keepalive, the 00:30 UTC daily roll-up, the 24-hour presigned URL lifetime, and credit pricing.
  • The Ruby examples were not executed.

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 change is a README-only restructure with added clarifications and examples, and the review evidence indicates there are no active issues outstanding.

No open issues 🎉

What changed in this PR

Reorganizes and expands the README to align with other Synthient SDK documentation structure while keeping existing wording and ensuring examples/options match the current Ruby SDK behavior.

Changes:

  • Reordered and regrouped sections (Installation, Quick Start, Authentication, Lookups, Account, Feeds, Error Handling, Retries/Timeouts, Configuration, Response Metadata, gRPC Schema, Requirements, Versioning, Documentation, License).
  • Added verified details and examples (client options/defaults, health/close, lookup input rules/limits, feed export pagination/download + checksum verification, retry/timeout behavior, response metadata/rate limit attributes, gRPC schema fetch options).
  • Added docs.synthient.com cross-links per section and a dedicated Documentation section.
File Description
README.md Restructures the README and adds/clarifies usage details and examples to better reflect current SDK behavior and link to corresponding docs.

Review effort: Balanced

@embeddinglayer
embeddinglayer deleted the docs/readme-polish branch November 15, 2026 23:08
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