docs(studio): finish the Node path across the remaining pages - #887
Conversation
Completes the sweep started in bnb-chain#885 and bnb-chain#886. Verified against the published @bnbagent/studio-cli 0.0.12 tarball. deployment.md — rewritten. It described shipping "two artifacts": Layer A to AgentCore and Layer B to EC2/Fargate, with `bag deploy agent` + `bag deploy package` + a manual EC2 upload. One runtime ships now, and every deploy explicitly selects bnb | aws | azure. Documents the real per-target constraints (48h testnet trial runs in the operator's cloud so signing material leaves your control; Azure is container-only and A2A-only) and the per-target secret channel (Secrets Manager / Foundry CustomKeys / managed store). Notes that local deliverable storage fails readiness by design, and that cloud lifecycle is delegated to the pinned @bnbagent/deploy-cli — no azd, no azure.yaml in the scaffold. configuration.md — dropped the second `app/service/studio.toml` config and the keyless-Service env section; one runtime means one studio.toml. `--project-root app/service` no longer exists. cli-reference.md — removed `bag deploy prepare --include-service-preflight` (absent from the shipped CLI) and the Python flat-imports section. Fixed `bag erc8004 register --endpoint .../apex/`: no `apex` route exists in the package; the runtime serves /readiness, /invocations, /responses, /mcp and /x402. troubleshooting.md — replaced the two-studio.toml drift check, the `main.py` flat-import advice, and the `@aws/agentcore` + Node>=20 prerequisite. Retargeted the funded-jobs checklist at the single runtime and /readiness, and noted settle is manual. demo.md — NOT rewritten, deliberately. It is a 610-line walkthrough of recorded IDE transcripts and command output. A faithful version has to be executed to be trustworthy, not adapted on paper; inferring one would produce a confident guide that does not work. Added a prominent banner pointing at the current Quickstart and Architecture, and fixed a pre-existing broken link (../../bnbagent-sdk/networks.md was one level too deep). Verified: the four rewritten pages contain zero stale markers, and all 37 relative links across the studio doc set resolve.
Pull Request ReviewThis documentation-only PR updates the remaining BNB Agent Studio pages to describe the current TypeScript, single-runtime deployment model with explicit BNB, AWS, and Azure targets. It revises deployment, configuration, CLI, and troubleshooting guidance, while marking the legacy two-layer demo as outdated and correcting its networks documentation link. Sensitive ContentNo sensitive content detected. Security IssuesNo serious security issues detected. Generated by Hashdit Bot. This tool can absolutely NOT replace manual audits. |
Caught in a verification pass on this PR. The `bag init` row still listed `--framework adk` and called the output a "two-layer workspace". Neither holds: - There is no `--framework` flag. `bag init` in @bnbagent/studio-cli 0.0.12 accepts --runtime, --llm-provider, --network, --wallet-kind, --protocols, --storage-provider, --onboard/--no-onboard, --ide, --destination, --erc8183-price. Verified against dist/bag.js. - The scaffold is one runtime, not two layers. Replaced with the real, verified flag set.
|
Follow-up fix pushed: the |
Pull Request ReviewThis documentation-only PR updates the remaining BNB Agent Studio pages to describe the current TypeScript, single-runtime deployment model with explicit BNB, AWS, and Azure targets, revised prerequisites, secret-delivery channels, endpoints, and CLI commands. It also removes obsolete two-layer and Python guidance, adds a prominent stale-content warning to the legacy demo, and fixes a relative link. Sensitive ContentNo sensitive content detected. Security IssuesNo serious security issues detected. Generated by Hashdit Bot. This tool can absolutely NOT replace manual audits. |
2 participants
Summary
Completes the Studio Node-path sweep from #885 and #886. Verified against the published
@bnbagent/studio-cli@0.0.12tarball.deployment.md— rewrittenThe page described shipping two artifacts: Layer A to AgentCore, Layer B to EC2/Fargate, via
bag deploy agent+bag deploy package+ a manual EC2 upload. One runtime ships now, and every deploy explicitly selectsbnb | aws | azure.Now documents the real per-target constraints and secret channels:
bnbawsWALLET_KEYSTORE_JSON)azureAlso: local deliverable storage fails readiness by design, and cloud lifecycle is delegated to the pinned
@bnbagent/deploy-cli— noazd, noazure.yamlin the scaffold.Targeted fixes
configuration.md— dropped the secondapp/service/studio.tomland the keyless-Service env section. One runtime means onestudio.toml;--project-root app/serviceno longer exists.cli-reference.md— removedbag deploy prepare --include-service-preflight(absent from the shipped CLI) and the Python flat-imports section. Fixedbag erc8004 register --endpoint .../apex/— noapexroute exists in the package; the runtime serves/readiness,/invocations,/responses,/mcp,/x402.troubleshooting.md— replaced the two-studio.tomldrift check, themain.pyflat-import advice, and the@aws/agentcore+ Node ≥ 20 prerequisite. Retargeted the funded-jobs checklist at the single runtime and/readiness, and noted settle is manual.demo.md— deliberately not rewrittenIt is a 610-line walkthrough built from recorded IDE transcripts and real command output. A faithful version has to be executed to be trustworthy — every prompt, output, and deploy result verified against a live run with a funded wallet and cloud accounts. Adapting it on paper would produce a confident-looking guide that does not work, which is strictly worse than an openly flagged stale one.
Added a prominent banner pointing at the current Quickstart and Architecture, and stated plainly why it is kept as-is.
Suggested follow-up: someone with a funded testnet wallet re-runs the walkthrough and captures fresh output — that is a recording task, not an editing one.
Also fixed a pre-existing broken link in that page:
../../bnbagent-sdk/networks.mdwas one level too deep.Verification
Layer A|Layer B|EC2|Fargate|app/service|apex/|main.py|managed_model|bnbagent_studio_core|@aws/agentcore|include-service-preflight)dist/before being kept or removed