Skip to content

docs: audit and align documentation with current behavior - #174

Merged
Zoupers merged 1 commit into
VirtualBeingsResearch:mainfrom
Zoupers:docs/audit-polish
Aug 16, 2026
Merged

docs: audit and align documentation with current behavior#174
Zoupers merged 1 commit into
VirtualBeingsResearch:mainfrom
Zoupers:docs/audit-polish

Conversation

@Zoupers

@Zoupers Zoupers commented Aug 16, 2026

Copy link
Copy Markdown
Collaborator

Summary

Whole-repository documentation audit and polish (44 files), plus a small runtime privacy default. Changes were verified against current source, web UI, package manifests, and generated release assets, and every paired *.md / *.en.md page was updated together.

Runtime privacy

  • Coworker now sets ANONYMIZED_TELEMETRY=false before any submodule import, so Chroma anonymous telemetry is opt-in rather than enabled by default (matching the existing MEM0_TELEMETRY=false default). Tests cover both the default and an explicit process-level opt-in.

Accuracy fixes

  • Go minimum for Relay: 1.26.5+1.26.6+ (matches go.mod/Dockerfile).
  • Corrected API__DEVELOPMENT_MODE scope: it only disables the API-side Desktop Bearer check; Desktop HTTPS is controlled by security.development_mode.
  • First-run wizard steps and captions now match the current bootstrap form (Provider/model/key/name/timezone/mode; advanced settings hold language and token limits).
  • Admin typed-name confirmation now lists real operations (full restore, short-term compression, restart) instead of deletion.
  • Bubble docs: ordinary bubble_done results return to the main line via the merge message; subconscious bubbles remain silent.
  • Channel docs: added Telegram to built-in channel selector and activity sharing, added Weixin Claw to channels.activity, corrected Desktop participant shape (coworker-desktop:d:local:…), and macOS Intel artifacts are x64.
  • Architecture docs: corrected tool lists (task_create/get/list/update, breathe), data/tasks.json, Telegram in globs/diagrams, English [automatic recall] marker, manage_memory(action="write"), and Person persistence path. Removed the architecture-decision question rubric from the philosophy pages.
  • Operations docs: GET /statususage_stats field instead of nonexistent /status.usage_stats; DeepSeek example model now deepseek-v4-pro; Relay wizard requires explicit public origin; admin listen bound to loopback; complete Relay frame list; clarified Compose restore volume semantics; added Relay restore steps.
  • Development docs: corrected Dev Container Python 3.14, Node minimums per real package engines, Tauri signer command, and heartbeat wording.
  • .coworker subconscious MODE files: aligned explore digest frequency (once per run), fixed archive command, switched user-preference memories to a valid manage_memory category with a user_preference tag, and aligned zh/en rules; golden tests updated.

Readability

  • Fixed spacing/typos and rewrapped long paragraphs in SECURITY/operations docs.

Validation

  • Link/image/heading checker: 0 missing files, 0 missing anchors.
  • Paired-page heading structure and image counts: consistent; remaining link differences are expected localized anchors.
  • git diff --check: clean.
  • pytest tests/unit/test_package_environment.py tests/unit/test_subconscious_mode.py tests/unit/test_i18n.py: 60 passed.
  • pytest tests/unit -k 'not browser': 1726 passed, 34 deselected on the latest commit.
  • ruff check on changed Python files: passed.

Checks not run / known gaps

  • Full unit suite in the available Docker environment reports 21 browser-tool failures because Playwright Chromium is not installed under /opt/ms-playwright; these are unrelated to this diff. Browser tests were not run.
  • Rust/Go/Web/Desktop build suites were not run for this documentation-oriented change.
  • Setup-wizard screenshots were not recaptured; captions were updated to match current UI text, and the screenshots should be refreshed in a follow-up UI docs pass.

@Zoupers
Zoupers force-pushed the docs/audit-polish branch from 0a250db to 156fec4 Compare August 16, 2026 01:24
@Zoupers
Zoupers force-pushed the docs/audit-polish branch from 156fec4 to d640abb Compare August 16, 2026 01:47
@Zoupers
Zoupers added this pull request to the merge queue Aug 16, 2026
Merged via the queue into VirtualBeingsResearch:main with commit af882ee Aug 16, 2026
8 checks passed
@Zoupers
Zoupers deleted the docs/audit-polish branch August 16, 2026 02:18
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.

1 participant