Repository navigation
docs: focus README on SDK setup and shared behavior - #37
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.
Summary
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.
Why
Keep the repository landing page focused on using the SDK. The final change edits only
README.mdandCHANGELOG.md; it adds no documentation files or documentation-check changes.Verification
make lint,make build,make test, andgo build ./examples/...— not rerun locally; no Go source or example changes.make docs-checkpassed during this change; generated API reference remains unchanged.Also passed: README local-link and Markdown-fence checks,
git diff --check, andpython3 .github/scripts/release_notes.py check. No live examples were executed. CI will validate the updated commit.Impact
UnreleasedinCHANGELOG.md..env.live, logs, or generated test output committed.