Repository navigation
docs: README accuracy and structure pass - #13
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 nit remains unresolved: the README contains a grammatically incomplete link text ("gRPC schema artifact's") that reads like a typo, so the change should be corrected before approval.
1 open issue
What changed in this PR
Reorganizes and refines the SDK README to align with the standard structure used across other SDKs, while adding source-backed clarifications and improving navigability.
Changes:
- Reordered and renamed README sections to a consistent SDK-wide layout and updated the table of contents.
- Added verified details for lookups, account health, feed pagination/downloads, retries/timeouts, configuration defaults, response metadata, and gRPC schema usage.
- Added cross-links to docs.synthient.com and a consolidated Documentation section.
| File | Description |
|---|---|
| README.md | Restructures the README to a standardized section order, adds source-derived behavioral details and defaults, and improves navigation with cross-links and expanded documentation. |
Review effort: Balanced
| ## Documentation | ||
|
|
||
| - [Java SDK guide](https://docs.synthient.com/sdks/java): [client](https://docs.synthient.com/sdks/java/client), [lookups](https://docs.synthient.com/sdks/java/lookups), [feeds](https://docs.synthient.com/sdks/java/feeds), [errors and retries](https://docs.synthient.com/sdks/java/errors), [types](https://docs.synthient.com/sdks/java/types), and [gRPC schema](https://docs.synthient.com/sdks/java/grpc-schema) | ||
| - [Javadoc](https://javadoc.io/doc/com.synthient/synthient-java), and the [gRPC schema artifact's](https://javadoc.io/doc/com.synthient/synthient-java-grpcschema) |
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.

Every claim and example in the README was checked against the source. Nothing was wrong, so this is a restructure plus a few additions; existing wording is kept and only moved.
Structure
# Developmentheading is gone.#feedshas one target. The method list's heading is nowFeed, the class name.Added (all from the source)
lookupDomain(domain)default of 50 events and the 1000 clamp; Punycode.health().listExports()default page size of 100, the 500 maximum,allExports(limit, cursor).Retry-Afterover one minute is not retried.close()does.rateLimit()can be null; storage downloads are not reported.FetchOptions(endpoint, symbols, plaintext, 30 second deadline),Schema.endpoint()/symbols(),SchemaException.code().Not verifiable from this repo (left as written)
BASIC), credit pricing, the 30 minute stream lifetime, the 15 second keepalive, the 00:30 UTC rollup, the meaning of each status code.