Repository navigation
docs: focus README on SDK setup and shared behavior - #12
Merged
Merged
Conversation
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.
Change
The README includes resource-specific API inventories and workflows that obscure SDK setup. Remove those sections and keep installation, authentication, a minimal example, and shared client behavior.
The final change edits only
README.mdandCHANGELOG.md. It adds no documentation files and makes no API, runtime, version, or compatibility changes. The same README scope is applied to Go, Python, TypeScript, and Java.Validation
make quality— not rerun locally; repository/version/link and changelog checks passed separately.Passed locally:
python3 .github/scripts/check_repository.py(version 0.2.0, 127 local links).python3 .github/scripts/release_notes.py check.No JDK-dependent build or live scenarios were run locally for this revision. CI will validate the updated commit; results from the previous PR revision are not presented as current results.