π Add Korean README and improve onboarding - #15
Conversation
Leverframe reviewπ‘ Incremental review completed in 366s
Changes |
There was a problem hiding this comment.
Leverframe review
One low-severity packaging defect found. Review used the CI-aligned Node.js 24.20.0 environment and exact declared pnpm 11.23.0. Repository checks otherwise passed apart from two IPv6 tests that fail identically at the base SHA.
Findings
1 finding was published inline.
Checks
6 passed Β· 3 failed Β· 0 not run
Show 9 checks
| Status | Check | Evidence |
|---|---|---|
| π’ passed | node --version && pnpm --version |
Node.js v24.20.0 and pnpm 11.23.0; these match CI's Node 24 and exact pnpm declaration. |
| π’ passed | pnpm install --frozen-lockfile |
Lockfile installation and supply-chain policy verification succeeded. |
| π’ passed | git diff --check 2cc958a7df1535022702c349fd06765dd655b793...0fcfa16d9e26c8eeabf9544c8934f755869e363d |
No whitespace errors. |
| π΄ failed | pnpm check |
Formatting, linting, and typechecking passed; 70 tests passed and two IPv6 ::1 integration tests failed before the chained build stage. |
| π΄ failed | focused base-SHA run of test/integration/status.test.ts and test/integration/cli.test.ts |
The identical two IPv6 failures reproduce at base SHA 2cc958a, so they were not introduced by this PR. |
| π’ passed | pnpm build |
tsdown 0.22.14 successfully produced the Node 24 bundle. |
| π’ passed | pnpm pack --dry-run --json |
Confirmed README.ko.md is included in the published package. |
| π΄ failed | pack, extract, and resolve README.ko.md relative links |
Five linked targets were absent from the generated package: CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md, docs/architecture.md, and test/README.md. |
| π’ passed | fetch current Secure MCP Tunnel and Docker Sandboxes documentation |
Authoritative documentation confirmed the tunnel variables, key source, connector workflow, permission model, and referenced sbx diagnostic commands. |
Limitations
-
The
sbxexecutable and Docker Sandbox service were unavailable, so real E2E tests were not run; the PR changes no sandbox runtime code. -
Authenticated ChatGPT and OpenAI Platform screens were not available. Their onboarding contracts were checked against current official OpenAI documentation and the linked tunnel-client guide instead.
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="#λΉ λ₯Έ-μμ">λΉ λ₯Έ μμ</a> Β· |
There was a problem hiding this comment.
π΅ [LOW] Packaged Korean README links to files absent from the package
The PR exposes README.ko.md from the English README and explicitly adds it to the npm package. After installation, this Architecture link resolves to node_modules/chat2sbx/docs/architecture.md, which is absent. The same problem affects its Security, Contributing, Tests, and Code of Conduct links, making substantial parts of the packaged Korean documentation unreachable.
Evidence: Packing and extracting chat2sbx-0.2.0 confirmed README.ko.md is present while docs/architecture.md, SECURITY.md, CONTRIBUTING.md, test/README.md, and CODE_OF_CONDUCT.md are missing.
Suggested action: Use absolute repository URLs for references not shipped in the npm package, or include all referenced documents in package.json#files.
Confidence: high
There was a problem hiding this comment.
Leaving this unchanged intentionally after checking current ecosystem behavior. GitHub recommends relative links for repository files because they keep working across branches, forks, and clones, and current npmjs.com rendering handles relative README links. The package keeps the user-facing READMEs but does not ship contributor, architecture, or test documentation solely to make local node_modules browsing self-contained. We can revisit this if the published npm page itself shows broken links.
There was a problem hiding this comment.
Leverframe review
Found one new medium-severity onboarding defect. Reviewed both changed READMEs using Node.js 24.20.0 and the repository-pinned pnpm 11.23.0, plus the current official sbx 0.42.1 CLI contract.
Findings
π‘ [MEDIUM] Initialize the network policy before running setup
README.md:42 Β· confidence: high
The fresh-install sequence runs chat2sbx setup before telling users to initialize Docker Sandboxes' network policy. When the template is absent, setup invokes sbx create; the current supported sbx CLI states that sbx policy init must run before starting the first sandbox. This prevents the documented sequence from completing on a fresh headless/non-interactive host, precisely where the following paragraph acknowledges initialization may be needed.
Evidence: README lines 39β43 order sbx login immediately followed by chat2sbx setup, while initialization is first mentioned on line 45. src/cli/setup.ts invokes sbx create to create a missing template. Official sbx 0.42.1 policy init --help says the command βmust be run before ... starting a sandbox for the first time.β
Suggested action: Place sbx policy init balanced (or an explicit instruction to choose another policy) before chat2sbx setup in both English and Korean quick starts.
Checks
8 passed Β· 1 failed Β· 1 not run
Show 10 checks
| Status | Check | Evidence |
|---|---|---|
| π’ passed | node --version; pnpm --version; sbx version |
Selected versions: Node.js v24.20.0, repository-pinned pnpm 11.23.0, and downloaded official sbx v0.42.1 for CLI-contract inspection. |
| π’ passed | pnpm format:check |
All 64 matched files passed formatting checks. |
| π’ passed | pnpm test:unit |
5 files and 14 tests passed. |
| π΄ failed | pnpm test:integration |
Initial run had two IPv6-loopback failures because this environment set NODE_USE_ENV_PROXY=1; this was environmental and unrelated to the documentation diff. |
| π’ passed | env -u HTTP_PROXY -u HTTPS_PROXY -u ALL_PROXY -u http_proxy -u https_proxy -u all_proxy NODE_USE_ENV_PROXY=0 pnpm test:integration |
All 8 files and 58 integration tests passed with proxy handling disabled for loopback. |
| π’ passed | pnpm lint; pnpm typecheck; pnpm build |
Oxlint/ESLint and TypeScript completed successfully; tsdown produced the Node 24 bundle. |
| π’ passed | pnpm pack --pack-destination <temporary-directory> |
Built chat2sbx-0.2.0 package and inspected its exact file list. |
| π’ passed | Repository-relative target scan and HTTP checks for README.md and README.ko.md |
Every relative target exists in the checkout. Changed OpenAI and Docker documentation URLs returned HTTP 200; npmjs returned an automation-specific HTTP 403. |
| π’ passed | sbx v0.42.1 policy init --help |
Confirmed policy initialization is a one-time prerequisite before starting the first sandbox. |
| βͺ not run | pnpm test:e2e |
The diff is documentation-only, and this host has no authenticated, KVM-ready Docker Sandboxes runtime. |
Limitations
- An actual first-sandbox creation was unavailable because the environment lacked an authenticated Docker Sandboxes runtime; the command-order failure was verified against setup's implementation, current Docker documentation, and the official sbx 0.42.1 CLI contract.
Summary
Verification
pnpm checkβ passed from a clean Node.js 24 environment, including format, lint, typecheck, 72 unit/integration tests, and build.pnpm test:e2eβ not run because this change only updates documentation and package file inclusion; it does not change sandbox runtime behavior.pnpm packβ verified that bothREADME.mdandREADME.ko.mdare included in the package tarball.git diff --checkβ passed.Notes
README.mdremains the canonical English documentation;README.ko.mdmirrors the same user-facing structure in Korean.docs/architecture.mdand security policy remains inSECURITY.md.node_modulesbrowsing.