[devswha]

The maintainer has asked for this to be merged (2026-10-27). It no longer waits for his own review.

What it does

Makes the README short. The top now answers what Ovis is, shows it, and says how to install it on a computer and a phone, with the desktop browser, Mac, Windows, Linux, iPhone and Android given equal weight. The Korean, Japanese and Simplified Chinese copies have the same sections.

• Logo, the tagline "Every coding agent, on every screen.", four badges (license, release, stars, herdr 0.9.0+). The PWA badge is dropped.
• One sentence on what Ovis is: the agents on your computer as chats you answer with a click or a tap, in any browser, the Mac app or your phone. "Formerly herdr web UI" stays.
• The hero is docs/media/readme/hero.webp (1200x675, 12 fps, 25 s, 1.5 MiB), linking to ovis.sh/demo. It is recorded on the demo build in the default Codex theme: a Claude Code turn on the desktop; the desktop and a phone side by side, where Codex's Allow command? card is answered on the phone and closes on both; then the release tab's shell as a live terminal. It replaces desktop-demo.gif.
• install: on your computer, Ovis.dmg (Mac), Ovis.exe (Windows) and the curl one-liner (Linux), which add herdr and Bun when missing (no Node), with INSTALL.md for every other way; on your phone, the iPhone TestFlight and Android Google Play betas (each translation links its own language's beta page) or the browser added to the home screen, and the QR code to connect.
• what you get: six short bullets, then one line each on the limits and on privacy, including that anonymous usage counts are on by default and how to turn them off.
• docs, thanks (now also crediting @sanguneo for the icon and website design), agent instructions, development, license.

What moved

• The long install section goes to INSTALL.md, which already covers every way to install step by step.
• The FAQ goes to the user guide's FAQ, which already has it; the README's docs list links it.
• The clip grid and the long video are dropped: their recordings show the previous UI.

The install anchor stays, because ovis.sh/install redirects to README.md#install; the translations keep their explicit <a id="install"></a>. Nothing else in the repo or on ovis.sh links to a README anchor that is gone (git grep).

Merge with main

main's #1858 (Grok chat on macOS) edited the Grok lines in the README feature list and FAQ. Both of those sections leave the README in this PR, and the same change is already in docs/guide.md on main, so the conflict was resolved by keeping this branch's READMEs.

Verification

• bun run check fast passes on the merged head.
• The README header test (src/lib/markdownHtml.test.ts) passes: logo width 100, language links, website link.

Documentation only, so there is no changelog fragment.

Follow-ups (not in this PR)

• ovis-site/llms.txt describes the README as "features, install and FAQ"; the FAQ now lives in docs/guide.md.
• src/components/PhonePanel.tsx links devswha/ovis#on-your-phone and #access-and-safety, anchors that live in docs/guide.md (this was already the case before this PR).
• scripts/film/capture.ts sets no theme, so it records the old amber theme from stored settings, and its R5-terminal take no longer runs.

[devswha]

bun run check fast on bbf6493 (this head, rebased onto 6c4d983): passes.

ok     workflow syntax
ok     generated types are fresh
ok     generated themes are fresh
ok     typecheck
ok     build
ok     unit tests   (6717 pass, 0 fail, 13 skip in 469 files)

An earlier run caught one regression of mine: src/lib/markdownHtml.test.ts reads the README's header and pins the logo at width="100". I had set 96; it is back to 100 in all four READMEs, and the test is unchanged.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

• Source mode: Auto
• Repository: devswha/ovis
• Branch: docs/readme-30s
• File: .coderabbit.yaml
• Commit: 228d442
• Layers: Repository YAML
• Review profile: CHILL
• Plan: Advanced
• Run ID: d4d5f8f4-5abf-4a6d-a961-9319a60323c6

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

No actionable comments were generated in the recent review.

Recent review info

Run configuration

• Source mode: Auto
• Repository: devswha/ovis
• Branch: docs/readme-30s
• File: .coderabbit.yaml
• Commit: bbf6493
• Layers: Repository YAML
• Review profile: CHILL
• Plan: Advanced
• Run ID: ac372412-5a8b-4f32-93de-474df7292fc5

Commits

Reviewing files that changed from the base of the PR and between 6c4d983 and bbf6493.

Files ignored due to path filters: 1

• docs/media/readme/phone-demo.gif is excluded by !**/*.gif

Files selected for processing: 4

• README.ja.md
• README.ko.md
• README.md
• README.zh-CN.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 0 remain after this review.

📝 Summary

Summary by CodeRabbit

• Documentation
  • Updated the README in English, Japanese, Korean, and Chinese with refreshed product information, setup instructions, feature overviews, and requirements.
  • Added a phone demo and clarified supported workflows and connectivity limitations.
  • Revised installation section headings and anchors.

The English, Japanese, Korean, and Simplified Chinese READMEs update Ovis branding and expand the introductory product, demo, installation, and feature information. The translated READMEs add a separate anchor and heading for detailed installation guidance.

Changes: Localized README updates

Layer / File(s)	Summary
README branding headers README.md, README.ja.md, README.ko.md, README.zh-CN.md	The four README headers add centered Ovis branding, taglines, updated badges, and language links.
Introduction and installation guidance README.md, README.ja.md, README.ko.md, README.zh-CN.md	The introductions add demo content, installation steps for macOS, Windows, and Linux, feature summaries, and setup requirements or limits.
Feature and detailed-installation sections README.md, README.ja.md, README.ko.md, README.zh-CN.md	The READMEs add headings before existing feature lists. The Japanese, Korean, and Chinese READMEs add a separate detailed-installation anchor and heading.

Priority: Normal

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Possibly related PRs

• devswha/ovis#1716: Adds translated introduction text in README files that this PR rewrites.
• devswha/ovis#1924: Changes the Windows installation entry point documented by this PR.
• devswha/ovis#1873: Adds the Windows installer and download path documented by this PR.

Suggested reviewers: snowykr

Merge Risk: Minimal · previous review bbf64

The changes are documentation-only, and the localized README updates have no established correctness or availability risk.

Pre-merge checks: 4

Check name	Status	Explanation
Title check		The title clearly summarizes the main README change: it explains that the opening now answers what, why, and how to install, and includes a phone demo GIF.
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.
Description check		The description is complete and relevant. It explains the README changes, moved content, anchor preservation, merge considerations, validation results, and follow-ups. It uses equivalent headings inst…

Full details: Description check

Explanation

The description is complete and relevant. It explains the README changes, moved content, anchor preservation, merge considerations, validation results, and follow-ups. It uses equivalent headings instead of the template headings and does not include an issue link, but the maintainer approval and detailed change description provide sufficient context for this documentation-only change.

Finishing Touches

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[devswha]

Merge pass review: PASS, held. This PR is not merged until the maintainer OKs it himself. The code review was done by omo-native-code-reviewer (claude-opus-5-5); here are its findings for him.

What checks out:

• Every link and claim was checked against the live site and v0.4.14:
  • ovis.sh/Ovis.dmg and /Ovis.exe redirect to the latest release, and both assets are on v0.4.14.
  • /beta/, /ko/beta/, /ja/beta/ and /zh/beta/ answer 200.
  • /demo/ and /install.sh redirect as _redirects says.
  • The badges show v0.4.14 and herdr 0.9.0+.
• "Adds herdr and Bun if missing; Node is not needed" holds for install.sh, install.ps1 and the Mac app.
• The herdr minimum, 0.9.0, matches install.sh and the plugin contract.
• The four READMEs have the same section order, and each links its own language's beta page.
• The #install, #install-details, #faq and #docs anchors work in every language.
• Five sampled GIF frames show only demo fixture data. The @devswha watermark is the only personal mark, and the GIF carries no metadata.
• The conventions, ovis-site and release-guards tests pass (69).

MEDIUM: phone-demo.gif is 3.5 MiB and loads first. That is more than the README's six WebP clips together (about 2.4 MB). A WebP from the source recording at about 10 fps would be much smaller; re-encoding the GIF only gets to about 2.3 MB.

LOW:

• Mac step (README.md:39): it says "open it and click Install", but the DMG opens a drag-to-Applications window. It also doesn't mention macOS 13+.
• Windows step (README.md:40): when Git for Windows is missing, the app shows Install Git first.
• QR claim (README.md:46): the QR appears only once tailscale serve HTTPS is set up. The linked details say so.
• The ja and zh license badges went from localized alt text back to English (README.ja.md:12, README.zh-CN.md:12).
• The PWA badge was removed from all four READMEs. Please confirm that is intended.

Already on main, not from this PR: src/components/PhonePanel.tsx:11-12 links #on-your-phone and #access-and-safety on the README. Those anchors live in docs/guide.md.

[devswha]

bun run check fast on c1b1bf6 (desktop hero, all four READMEs): passes.

ok     workflow syntax
ok     generated types are fresh
ok     generated themes are fresh
ok     typecheck
ok     build
ok     unit tests   (6717 pass, 0 fail, 13 skip in 469 files)

This head drops phone-demo.gif and adds desktop-demo.gif; the PR body describes the new top. It merges cleanly with main at 72acea8 (chore(release): 0.4.15), which touches no README.

[devswha]

Merge pass note: #1858 (b510ce3) merged to main and edited the agent tables in the READMEs. This PR now conflicts with main in README.md, README.ko.md, README.ja.md and README.zh-CN.md.

It stays held until the maintainer has checked it. A rebase before that check would let the maintainer look at the current text.

[cloudflare-workers-and-pages]

Deploying ovis with    Cloudflare Pages

Latest commit:	228d442
Status:	✅  Deploy successful!
Preview URL:	https://da46be5f.ovis.pages.dev
Branch Preview URL:	https://docs-readme-30s.ovis.pages.dev

View logs

[devswha]

Merged at the maintainer's request (squash, head 228d442, merge commit 88ce174) without a CodeRabbit review: CodeRabbit skipped this head, and the PR is docs only (four READMEs and docs/media/readme/hero.webp), so per AGENTS.md it needed no new review. Required checks: Fast checks and Integration and browser passed; Native Windows install was skipped for a docs-only change. The README conflicts with #1858 were resolved by keeping the shortened READMEs; the Grok wording #1858 added is in docs/guide.md on main, which the READMEs link to. The readme-live herdr workspace is left open because its agent pane is still in use.