docs: rewrite README for clarity and professionalism - #1103
Conversation
- Remove outdated screenshots (will add fresh ones separately) - Add badge row (CI, .NET, license, Discord) - Condense intro to one punchy sentence - Add quick-links row and install table - Replace verbose feature lists with concise grid - Move Mac parity table, Quick Send troubleshooting, node capabilities reference, deep links table, and Command Center diagnostics to linked docs - Keep essential dev workflow: setup, build, run, test - Add Documentation links table - Consistent structure: Install > Features > Projects > Dev > Config > Docs > License Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 049e0978-76d3-4105-82c7-898a2fd7f4fd
- Title: 'OpenClaw Windows Hub' (matches product name) - Intro: one sentence what-it-is, one what-it-does (no feature-list sentence) - Install: mention 'Set up locally' happy path - Step 3: concrete CLI example instead of vague config reference - 'Also included' -> 'Features' (proper header) - Docs table: split contributor-facing (table) from user-facing (inline links) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 049e0978-76d3-4105-82c7-898a2fd7f4fd
Bring back setup-dev.ps1 flags, build.ps1 -Project, dotnet build with RID (WebView2 gotcha), run-app-local.ps1 -NoBuild/-Dev/-Isolated, and MSIX build command. Organized into Prerequisites/Build/Run/Test subsections instead of one dense block. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 049e0978-76d3-4105-82c7-898a2fd7f4fd
- Node Mode: expand to 4 steps with actual allowCommands JSON config - Add privacy warning (no wildcards, screen.record/camera are opt-in) - Add verify step with test commands from gateway side - Add Deep Links table (key links, not all 30+) - Add File Paths table (settings, logs, gateways, exec-approvals) - Link MCP Mode doc from features list Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 049e0978-76d3-4105-82c7-898a2fd7f4fd
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 049e0978-76d3-4105-82c7-898a2fd7f4fd
|
Codex review: needs changes before merge. Reviewed August 5, 2026, 6:45 PM ET / 22:45 UTC. ClawSweeper reviewWhat this changesThe PR rewrites the README, adds a title icon, and adds a tray navigation route for a sandbox-session prototype page. Merge readiness⛔ Blocked by patch quality or review findings - 4 items remain Keep open. The current head still references an undefined page type, so it cannot compile. Likely related people: Barbara Kudiess (high confidence) and Karen (medium confidence) from recent tray-window history. Priority: P2 Review scores
Verification
How this fits togetherThe README guides users and contributors into the Windows companion app. The tray window maps navigation selections to WinUI pages, so each added menu item must resolve to an implemented page. flowchart LR
A[User or contributor] --> B[README]
B --> C[Windows companion setup]
D[Tray menu selection] --> E[Navigation route]
E --> F[WinUI page]
F --> G[Sandbox experience]
Before merge
Findings
Agent review detailsSecurityNone. Review metrics
Merge-risk optionsMaintainer options:
Technical reviewBest possible solution: Keep the README rewrite scoped to documentation by removing the prototype route and menu item, or submit a separate UI PR that implements and validates the complete page. Do we have a high-confidence way to reproduce the issue? Yes. Current source lacks the page named by the new route, and building the tray project would establish the resulting compile failure. Is this the best way to solve the issue? No. A README-focused PR should not add an unresolved navigation route; remove it or move a complete, validated page into a dedicated UI PR. Full review comments:
Overall correctness: patch is incorrect AGENTS.md: found and applied where relevant. Codex review notes: model internal, reasoning high; reviewed against d2de6150753b. LabelsLabel justifications:
EvidenceAcceptance criteria:
What I checked:
Likely related people:
Rating scale
Overall follows the weaker of proof and patch quality. Workflow
HistoryReview history (1 earlier review cycle)
|
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Summary
Rewrite the README around the shipped OpenClaw Companion experience. The normal setup path now directs users through Companion Settings, Connection, Sandbox, Permissions, Command Center, and the schema-guided Config page instead of asking them to edit
openclaw.jsonby hand.Changes
README.mdonlyValidation
./build.ps1dotnet test ./tests/OpenClaw.Shared.Tests/OpenClaw.Shared.Tests.csproj: 3,399 passed, 32 skippeddotnet test ./tests/OpenClaw.Tray.Tests/OpenClaw.Tray.Tests.csproj: 2,037 passedReal behavior proof
92f28a424a3c7a8fab66ba23bf86857135d9887aREADME.md