Skip to content

docs: clarify README purpose and getting started - #22

Merged
anycodes merged 1 commit into
mainfrom
docs/readme-review-20261028
Oct 28, 2026
Merged

anycodes merged 1 commit into
mainfrom
docs/readme-review-20261028

Conversation

@anycodes

Copy link
Copy Markdown
Contributor

Summary

Describe the HTTP client scope and actual source installation. Provide one complete service example and an operation table. Keep application-versus-gateway authentication and sandbox cleanup visible. Move complete HTTP/authentication and configuration tables into bilingual docs/server-client and docs/configuration references without changing their contract.

Requested as a review and improvement of all eight repository READMEs. This PR covers only nodejs-sdk. Migration and maintenance details remain available through their owning guides. No runtime code or public API changes.

Type of Change

  • Documentation

Changes

  • Rewrite the repository entry point for its primary audience and provide matching English/Chinese navigation.
  • Keep detailed reference or maintainer material in its appropriate guide.
  • Add the owning repository decision and dated verification record.

Testing

  • Changed Markdown targets/fragments, incoming README anchors, language switches and Python snippet syntax: pass.
  • Scoped diff and translation review: pass.
  • npm ci: PASS.
  • npm run typecheck: PASS.
  • npm test: FAIL initially: the selected system Python did not have agent-sandbox-server installed; two agent-loop tests failed with ModuleNotFoundError, 27 passed.
  • npm test (PATH selects the fresh SDK/server Python environment): PASS: 29 tests, 0 failures.

Checklist

  • English and Chinese documentation updated
  • Repository-owned note and verification included
  • No secrets or unrelated changes included
  • Existing licenses and attribution preserved

Notes for reviewers

Documentation-only scope. Existing cloud/model acceptance receipts are preserved; no new runtime, model, cloud deployment or package-release claim is made. Runtime/template-specific checklist items are not applicable. Required latest-head CI and review gates remain in effect.

@anycodes
anycodes merged commit 1505b61 into main Oct 28, 2026
2 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