Skip to content

docs: fix inaccuracies found auditing docs against the code#554

Merged
Th0rgal merged 1 commit into
Th0rgal:masterfrom
adrienlacombe:docs/accuracy-audit
Jun 17, 2026
Merged

docs: fix inaccuracies found auditing docs against the code#554
Th0rgal merged 1 commit into
Th0rgal:masterfrom
adrienlacombe:docs/accuracy-audit

Conversation

@adrienlacombe

Copy link
Copy Markdown
Contributor

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

  • docs/MISSION_API.md — SSE status tool_waitingwaiting_for_tool; removed a non-existent GET /api/control/tree row; rewrote command_source/trigger to the internally-tagged serde form ({"type":"library","name":...}, {"type":"interval","seconds":...}, {"type":"inline","content":...}) with cron + local_file examples; AutomationExecution fields started_at/result_messagevariables_used/error.
  • docs/WORKSPACE_API.md — removed the non-existent tools field (create/update/object/table) and stdin from exec; init log path sandboxed.sh-init.logsandboxed-init.log.
  • docs/WORKSPACES.md — hyphenated helper script names (sandboxed-network-up, sandboxed-tailscale-up); log path fix.
  • docs/BACKEND_API.md — corrected the config-update response message to match src/api/backends.rs.
  • docs/install-docker.md — service name sandboxed-sh, volume sandboxed-data; added orchestrator-mcp/assistant-mcp to the binary list; Docker desktop stack Xvfb/i3/xdotool/scrot → Sway/grim/wtype/wlrctl/wf-recorder (Wayland, per Dockerfile); logs command service name.
  • docs/install-native.md — removed a false "sample template ships at library-template/..." claim; fixed helper script names; dev port 30003001.
  • docs/DESKTOP_SETUP.mdDESKTOP_DISPLAY_START=99DESKTOP_DISPLAY=:99 (matches the env var the code reads).
  • INSTALL.md — comparison table: Docker desktop automation "headless Xvfb" → "headless Wayland/Sway" (Dockerfile uses Wayland; native correctly stays X11/Xvfb).
  • dashboard/README.md — JWT stored in localStorage (not sessionStorage); bun dev (the dev script hardcodes --port 3001).
  • android_dashboard/README.mdminSdk 26minSdk 33; stale version heading generalized.
  • PROVIDER_HEALTH_CHECK.mdglm-4-flashglm-4.7-flash.
  • backend/STREAMING.md, docs/HERMES_ASSISTANT_MIGRATION.md, mobile-app-reliability.mdsrc/api/control.rssrc/api/control/mod.rs (the file became a module directory).
  • ASK_ASSISTANT_DESIGN.md — tool loop "≤6 iterations" → "≤10 iterations" (matches MAX_ITERATIONS).

Test plan

  • Maintainer review of each correction against current code/config
  • Confirm desktop-automation phrasing (Docker = Wayland, native = X11) matches intended deployment story

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>
@vercel

vercel Bot commented Jun 17, 2026

Copy link
Copy Markdown

@adrienlacombe is attempting to deploy a commit to the LFG Labs Team on Vercel.

A member of the Team first needs to authorize it.

@Th0rgal

Th0rgal commented Jun 17, 2026

Copy link
Copy Markdown
Owner

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: tool_waitingwaiting_for_tool is the real emitted string; GET /api/control/tree indeed isn't a registered route; CommandSource/TriggerType are #[serde(tag="type")] with the documented variant shapes; AutomationExecution fields; src/api/control.rssrc/api/control/mod.rs; Sway/grim/wtype desktop stack; dashboard dev port 3001 + localStorage JWT; sandboxed-* script/log names; Android minSdk 33; the removed tools/stdin request fields). No incorrect corrections or new inaccuracies found. One pre-existing out-of-scope nit: DESKTOP_SETUP.md still calls DESKTOP_RESOLUTION the "Xvfb resolution" though the stack is Wayland now. LGTM to un-draft and merge.

@adrienlacombe adrienlacombe marked this pull request as ready for review June 17, 2026 15:31
@Th0rgal Th0rgal merged commit dfb01cb into Th0rgal:master Jun 17, 2026
18 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants