Skip to content

docs: focus README on SDK setup and shared behavior - #39

Merged
moonyue-w merged 2 commits into
mainfrom
codex/readme-scope
Nov 2, 2026
Merged

moonyue-w merged 2 commits into
mainfrom
codex/readme-scope

Conversation

@moonyue-w

@moonyue-w moonyue-w commented Nov 2, 2026 •

Copy link
Copy Markdown
Collaborator

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.md and CHANGELOG.md; it adds no documentation files or documentation-check changes.

Verification

  • Full lint, typecheck, test and example --help suites — not rerun locally; SDK and example source are unchanged.
  • make docs-check passed for the updated README; the existing check script is unchanged from main.
  • Account-backed integration tests not required for this documentation-only change.

Also passed: README local-link and Markdown-fence checks, git diff --check, and python3 .github/scripts/release_notes.py check. No live examples were executed. CI will validate the updated commit.

Impact

  • Public API or runtime behavior changed — no SDK source changes.
  • Documentation change recorded under Unreleased in CHANGELOG.md.
  • Generated API documentation or contract fixtures updated — neither is changed.
  • Cross-SDK consistency considered across Go, Python, TypeScript, and Java.
  • Breaking-change migration notes — not applicable.
  • No credentials, .env.live, logs, or generated test output committed.

@moonyue-w
moonyue-w merged commit 25dcc1a into main Nov 2, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant