Skip to content

Docs: README and every document, for the app as it is - #43

Merged
MasterYoav merged 2 commits into
masterfrom
docs-refresh
Oct 12, 2026
Merged

MasterYoav merged 2 commits into
masterfrom
docs-refresh

Conversation

@MasterYoav

Copy link
Copy Markdown
Owner

The README and the whole docs/ folder described xBot 1.x (Docker, OpenBot, the model router). This rewrites them for the app as it is, with every claim checked against the code.

  • README: what xBot is now (four agent CLIs, the crew organised like a company, the pixel worlds, the iPhone/iPad remote), honest status (no signed 2.0 yet; 1.0.0 is the Docker app), build-from-source commands, a table of every doc.
  • Rewritten: 01-vision, 02-architecture, 04-model-providers (now "Agents and providers"), 05-mac-app, 06-onboarding (now "First run"), 08-design-system, 09-ui-spec (every screen of both apps), 10-security (with a threat model and known weaknesses), 11-packaging-and-updates, 12-roadmap, 13-launch-checklist, scripts/README-packaging.md.
  • New: 14-iphone-and-ipad.md (lanes, pairing, protocol, features, tests, measurements).
  • Index: reading order, ADR statuses, a table of all design specs with their state.
  • ADR-0009 gets a "Since then" section (four CLIs; the phone's listening port). The redesign and mobile specs get status notes; 1.x plans are marked as history; dead links to deleted 1.x docs are unlinked.
  • CHANGELOG: entries for Fix the panel toggle and tab close; edit and resend a prompt #18–Agents as a company: who reports to whom #42.

Not touched: CLAUDE.md (waiting on the owner), site/index.html (still 1.x).

Code issues found while documenting (listed in 10-security.md and 11-packaging-and-updates.md, not fixed here): unused pairing codes stay valid; one QR can pair several devices; hand-offs start in Can edit; uninstall-xbot.command misses the automations LaunchAgent and pairing keys; Sparkle's feed 404s while the only release is a pre-release; Info.plist still says 1.0.0 and credits the engine; ⌘↩ is bound to both Run plan and Commit.

…CLIs, the crew as a company, automations, the iPhone and iPad remote)
@MasterYoav
MasterYoav changed the base branch from mobile-org to master October 12, 2026 11:59
@MasterYoav
MasterYoav merged commit ba12e23 into master Oct 12, 2026
1 check passed
@MasterYoav
MasterYoav deleted the docs-refresh branch October 12, 2026 12:03
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