docs: fix inaccuracies found auditing docs against the code#554
Conversation
Audited all repository docs against the v1.3.0 source and corrected
claims that no longer match the code:
- MISSION_API: command_source/trigger JSON shapes are internally tagged
({"type": ...}); inline uses `content` not `command`; remove the
non-existent GET /api/control/tree row; SSE status uses
`waiting_for_tool`; AutomationExecution exposes `variables_used`/`error`
(not `started_at`/`result_message`).
- WORKSPACE_API/WORKSPACES: drop the non-existent `tools` field and `stdin`
exec input; init log is /var/log/sandboxed-init.log; helper scripts are
sandboxed-network-up / sandboxed-tailscale-up.
- BACKEND_API: update-config response message no longer mentions a restart.
- install-docker: compose service is `sandboxed-sh`, volume `sandboxed-data`;
list all five MCP binaries; desktop stack is Wayland (Sway), not X11.
- install-native: remove the non-existent in-repo residential.json template
path; fix helper script names; dev server runs on :3001.
- DESKTOP_SETUP: env var is DESKTOP_DISPLAY (not DESKTOP_DISPLAY_START).
- dashboard README: JWT stored in localStorage; `bun dev` already serves :3001.
- android README: minSdk is 33 (Android 13).
- PROVIDER_HEALTH_CHECK: Z.AI health model is glm-4.7-flash.
- STREAMING/HERMES/mobile-app-reliability: src/api/control.rs is now
src/api/control/mod.rs.
- ASK_ASSISTANT_DESIGN: ask tool loop cap is 10 iterations.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
@adrienlacombe is attempting to deploy a commit to the LFG Labs Team on Vercel. A member of the Team first needs to authorize it. |
|
Reviewed (read-only) — leaving it since it's a draft. Verified ~30 of the corrections against the current code and every one matches (spot-checked the high-value claims: |
Summary
Audited the repository documentation against the current code and fixed concrete, verifiable inaccuracies (commands, paths, env vars, ports, API endpoints/shapes, version/SDK numbers, binary/stack names, and stale module paths). Scope was limited to factual corrections — design intent, roadmap, and historical/log artifacts were left untouched.
Changes by file
tool_waiting→waiting_for_tool; removed a non-existentGET /api/control/treerow; rewrotecommand_source/triggerto the internally-tagged serde form ({"type":"library","name":...},{"type":"interval","seconds":...},{"type":"inline","content":...}) with cron + local_file examples;AutomationExecutionfieldsstarted_at/result_message→variables_used/error.toolsfield (create/update/object/table) andstdinfrom exec; init log pathsandboxed.sh-init.log→sandboxed-init.log.sandboxed-network-up,sandboxed-tailscale-up); log path fix.src/api/backends.rs.sandboxed-sh, volumesandboxed-data; addedorchestrator-mcp/assistant-mcpto the binary list; Docker desktop stack Xvfb/i3/xdotool/scrot → Sway/grim/wtype/wlrctl/wf-recorder (Wayland, per Dockerfile); logs command service name.3000→3001.DESKTOP_DISPLAY_START=99→DESKTOP_DISPLAY=:99(matches the env var the code reads).localStorage(notsessionStorage);bun dev(the dev script hardcodes--port 3001).minSdk 26→minSdk 33; stale version heading generalized.glm-4-flash→glm-4.7-flash.src/api/control.rs→src/api/control/mod.rs(the file became a module directory).MAX_ITERATIONS).Test plan