docs: restyle README header and correct stale facts - #3528
Conversation
Center the latest Desktop icon with the project name, and replace the mixed CI/license/docs badges with a coordinated star, download, license, and platform row. Platform badges split support (macOS arm64), unsigned preview (Windows), and not-yet (Linux) instead of one combined pill. Also un-drift the body: sandbox boundary instead of permission engine, align the Chinese Windows sentence with English, replace 外部竞品 with external subjects, and point the Windows roadmap issue at apache/maka.
Rewrite Why Maka and the capability lists without internal slogans. Name Computer Use and IM bots as optional/experimental. Collapse the SQLite backup, Phase 2/3, and vault-mode handbook into a short data and recovery section with links to SECURITY, privacy, and resume docs.
Astro-Han
left a comment
Astro-Han
left a comment
There was a problem hiding this comment.
Thanks — moving the entry page from maintainer detail to user-facing language is the right call, and net −50 lines for a README is the good direction.
Reviewed at exact head 9a844c61b165bd6b76361c0086507be8c809fca8, freshly fetched. test is green. Three files: both READMEs and docs/windows-support.md.
The thing I most wanted to check on a docs deletion is whether a warning lost its only home. It hasn't — empty threads after upgrade, credentials needing re-entry, resume spending tokens, and "no published Apache release yet" all survive in the new copy. What went is architecture and backup-implementation detail that ARCHITECTURE.md and the privacy/resume docs already own, so this removes a duplicate rather than the fact itself.
Also verified rather than assumed: the badges and in-repo icon resolve, every relative link across the three files resolves, issue #2142 is still the live Windows tracking issue, and the current release really does carry macOS arm64 plus unsigned Windows x64 — so the platform claims match reality. The Chinese and English READMEs stay in step on structure, platform status and warnings.
One thing I'd expected to find and didn't: no stale PermissionEngine phrasing survives here. SECURITY.md now frames the boundary in OS-account terms and this copy agrees with it.
No findings. Approving.
This review was AI-assisted. Findings were verified against the exact head listed above; any mistakes are mine to correct — please push back where I got it wrong.
2 participants
Summary
Restyle the README opening the way the owner asked, and un-drift a few stale facts.
apps/desktop/assets/icon.png) with the project name.permission enginewith the sandbox boundary.外部竞品→ external subjects.docs/windows-support.mdissue roadmap(windows): make Windows a supported platform #2142 atapache/maka.Verification
main(PermissionEnginegone; Windows is unsigned preview).Checklist
Does this PR entail a change in behavior?