docs(computer-use): document package boundaries - #4016
Conversation
Generated-by: OpenAI Codex
Astro-Han
left a comment
There was a problem hiding this comment.
Almost ready - one statement doesn't match the code, and for a documentation PR that is the only thing that can be wrong, so I'd like it fixed before approving.
packages/computer-use/README.md, "Current platform boundary", condition 2. The README says the selector enables Computer Use only when "the composition supplies an absolute maka-cu executable path". selectComputerUseBackend (select-backend.ts) checks process.platform !== 'darwin', then !deps?.binaryPath || !deps.expectedBinarySha256, then falls to NONE on any construction throw - it never checks absoluteness, and isAbsolute does not appear anywhere in packages/computer-use/src. A relative path passes selection and is resolved against the process cwd. The consequence is bounded because the SHA-256 digest still gates the bytes, but the sentence promises a guard that isn't there, and whoever wires a composition is exactly the reader who would rely on it. Either drop "absolute", or add the check to the selector so the sentence becomes true.
Everything else checks out against source, which I verified rather than read past:
src/index.tsreally is the single root entry (package.jsonexportsis the bare"./dist/index.js"), and each named export exists.CU_BACKEND_IDSis['maka-cu'].- The three fail-closed paths to
backendId: 'none'match the code exactly. MakaCuLifecycleError,MakaCuRpcErrorandMakaCuProtocolViolationall exist, in the files implied.- All three linked documents exist, and the
docs/README.mdentry sits in the package-README group where it belongs. - The claimed test coverage maps one-to-one onto the seven files in
src/__tests__/- protocol, service lifecycle, backend, host events, display snapshot, overlay hook, cumulative e2e - rather than being a generic claim.
The Windows spawn EFTYPE failures you noted are pre-existing fixture behavior and unrelated: this PR touches Markdown only.
AI-assisted review disclosure: Claude Code cross-checked each README statement against the package source; I verified the selector gate, the export surface, and the test-coverage mapping against current main myself.
Generated-by: OpenAI Codex
|
Addressed in commit 184a5a8. The README now says the composition supplies a Re-ran Automated response from OpenAI Codex at @yuzhiyang1's direction. |
Summary
Add a package-local README for @maka/computer-use and link it from the documentation authority map. It documents the package boundary, public exports, current macOS and maka-cu selection constraints, fail-closed behavior, protocol and lifecycle ownership, verification commands, and tracked cross-platform work.
All statements are grounded in the current source; this does not add setup or distribution promises.
Fixes #4004
Verification
AI use
Select exactly one:
Tool(s) and scope: OpenAI Codex assisted with repository analysis, documentation drafting, verification, and PR drafting. The human contributor reviewed the change and remains responsible for it.
Checklist
Does this PR entail a change in behavior?