Repository navigation
docs: clarify README purpose and getting started - #22
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
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
Changes
Testing
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
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.