Repository navigation
docs: README accuracy and structure pass - #3
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.
🟡 Changes recommended
A documentation inconsistency remains unresolved: the README describes lookupDomain using different terminology than the SDK’s Synthient\Client::lookupDomain PHPDoc, which could confuse users and needs alignment before approval.
1 open issue
What changed in this PR
Updates and reorganizes the README to better align with the SDK’s actual surface area, improve navigability, and expand source-backed usage guidance.
Changes:
- Reordered and renamed major sections (Installation/Quick Start, Authentication, Lookups, Account, Feeds, Errors, Retries and Timeouts, Configuration, Response Metadata, Versioning).
- Added/expanded examples and behavioral notes for lookups, account health, feeds/exports (including pagination details), retries/timeouts, and response metadata.
- Added a constructor options table, improved internal section links, and included links to relevant pages on docs.synthient.com.
| File | Description |
|---|---|
| README.md | Restructures and expands the README with updated section organization, additional examples/behavior notes, configuration/reference tables, and improved internal/external documentation links. |
Review effort: Balanced
|
|
||
| - [`lookupIp`](#look-up-an-ip-address) - Look up an IPv4 or IPv6 address | ||
| - [`lookupIps`](#look-up-many-ip-addresses) - Look up as many as 1000 addresses in one request | ||
| - [`lookupDomain`](#look-up-a-domain) - Look up the honeypot traffic observed for a domain |
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.

README only. Every statement was checked against
src/andcomposer.json; no existing statement was found to be wrong, so this pass is structure, completeness, and links.Structure (same section order as the other SDK READMEs; existing wording kept)
SDK Installation→Installation; the first lookup is now aQuick Startprogram.API Keysmoved underAuthentication.SDK Example Usagesplit intoIP and Domain LookupsandAccount.Streaming,Pagination, andDownloadsare now under oneFeedssection.Error Handling→Errors;RetriesandTimeouts→Retries and Timeouts.Server SelectionandCustom HTTP Clientmoved under a newConfigurationsection.Debugging→Response Metadata;Maturity→Versioning;Requirementsmoved near the end; theDevelopmentH1 is gone.Available Resources and Operationsnow link to their sections.Added (all from the source)
networkandlocation; the 422 for private addresses; empty batch returns[];Client::MAX_BATCH_SIZE; nothing billed when the batch can't be covered;lookupDomainlimitdefault 50 / clamp 1000, the 30-day window, Punycode, and the inactive result for an unobserved domain.lookupQuota->resetsIn, and ahealth()example (503ApiException).listExports/allExportspage size (default 100, clamp 500); building an hourly ID withformat('Y-m-d/G').Retry-Afterover a minute is thrown instead of waited for, TLS failures are not retried, retries get a fresh timeout.ResponseMetadataproperties andRateLimitfields; storage responses don't reach the hook.Documentationsection.Left as is
Could not verify from this repo
lookupDomainis described as "honeypot traffic" here and as "proxy traffic" in theClient::lookupDomainPHPDoc. The README wording is kept.