Repository navigation
docs: README accuracy and structure pass - #9
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 change is limited to restructuring and correcting the root README with clarified technical details, added verified examples, and updated links, and the review evidence indicates no outstanding issues to resolve.
No open issues 🎉
What changed in this PR
Updates the root README to better match the SDK’s actual behavior and align its structure with other SDK READMEs.
Changes:
- Reordered sections and updated the table of contents to match the new layout.
- Added/expanded verified examples and behavioral notes across lookups, feeds, errors, retries/timeouts, configuration defaults, response metadata, and gRPC schema.
- Corrected specific technical details (e.g.,
FileDescriptorSetimport location and clarifyinggetSecretas user-provided code) and added links to relevant documentation pages.
| File | Description |
|---|---|
| README.md | Restructures and corrects the README, adding verified usage examples and behavior notes aligned with the current SDK implementation. |
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.
README only. Existing wording is kept wherever it was already correct; sections are reordered so the SDK READMEs share one layout, and gaps against the source are filled.
Structure
Corrections
FileDescriptorSetcomes from@bufbuild/protobuf/wkt, not@bufbuild/protobuf(src/grpcschema.ts).getSecretsnippet now saysgetSecretis the reader's own code.Additions, each checked against the source
TypeErrorfor a non-IP string and the 422 for private addresses;lookupIPstakes any iterable and returns[]for an empty one;lookupDomainlimitdefault and clamp, theinactiveresult, Punycode (src/client.ts).toDate(src/types.ts).healthexample (src/client.ts).timeout, Heliostunnel_idkept as a string,listExportslimitdefault and clamp, adailyExport+exportMetaexample (src/feed.ts).SchemaErrorin the hierarchy, and whenAPIConnectionErrorhas acause(src/errors.ts,src/grpcschema.ts).Retry-Afterexceeds 60 s (src/transport.ts).ClientOptionsfield with its default;VERSION(src/client.ts).FetchSchemaOptions,DEFAULT_ENDPOINT,SchemaError.code.Not verifiable from this repository (server behaviour, left as written)
Retry-Afterwhile a daily export rolls up.limit(stated in the source comments only).