Files
multica/docs/assets
Jiayuan Zhang 20a4a8da87 docs(readme): rebuild the README around a product hook and job-based features (MUL-5812) (#6506)
* docs(readme): rebuild the README around a product hook and job-based features (MUL-5812)

The README had drifted badly: 1771 commits landed in three months while its
feature list last changed on 2026-05-24, and both screenshots dated to
2026-04-14 — a UI that predates the type-scale migration, the execution log
rebuild, and the issue detail rework. Whole surfaces were missing (Chat, Inbox,
Projects, usage analytics, self-hosted Git, the chat-bot integrations), the
desktop app appeared nowhere at all, and iOS was a footnote under Development.

The roster drift had a mechanism: the runtime list was repeated five times per
README, so every new provider needed ten hand edits. Four had gone missing
(deveco, grok, qwen, qwenpaw). Each README now lists it once, between markers,
and scripts/check-readme-runtimes.sh fails CI when either table drifts from
scripts/agent-cli-command-names.txt.

Structure follows what warp, block/buzz, openclaw, and hermes-agent do: the
product screenshot lands before any prose, features are grouped under job verbs
rather than flattened into one list (Notion's features page), and the docs table
is goal-oriented. Screenshots are the ones already shipping on the docs site, so
they are days old rather than months.

Moves the Multics origin story out of position two into VISION.md alongside the
vision narrative approved in MUL-4877, which had no home in the repo before.
Adds a Works today inventory that names the rough edges (iOS not on the App
Store, no Android, DingTalk community-maintained) instead of leaving readers to
find them.

README.zh-CN.md stays a 1:1 mirror and follows the Chinese glossary in
apps/docs/content/docs/developers/conventions.zh.mdx: agent as 智能体, issue as
任务, autopilot as 自动化.

Co-authored-by: multica-agent <github@multica.ai>

* docs(readme): fix nav paths, switch to .zh.md i18n naming, rework project status (MUL-5812)

Review feedback on #6506:

- The setup steps sent people to Settings for both Runtimes and Agents. Both
  are sidebar destinations (packages/views/layout/app-sidebar.tsx: runtimes
  under Configure, agents under Workspace), and the button reads "New agent".
- Renames README.zh-CN.md / VISION.zh-CN.md to README.zh.md / VISION.zh.md so
  translations match the locale suffix the docs site already uses (.zh, .ja,
  .ko). check-readme-runtimes.sh now discovers README.md plus README.*.md
  instead of hardcoding the list, so a new locale is covered the day it lands.
- Reworks "Works today", which re-listed the features the four groups had just
  covered and buried the honest part underneath. It is now "Project status": a
  per-surface table saying how finished each one is, including the parts we'd
  rather people hear from us (iOS off-store, no Android, DingTalk without an
  SLA). No feature re-listing.
- Drops the banner. It was generic scenery that said nothing about the product
  and pushed the logo, tagline, and board screenshot below the first viewport.
  The board screenshot is the hook, so it now leads.

Also revises the Chinese throughout. The first pass tracked the English clause
by clause and read like a translation; this one keeps the meaning but uses
Chinese sentence rhythm, and follows the shipped UI strings — assignee 负责人,
in_review 审核中, execution log 执行日志.

Co-authored-by: multica-agent <github@multica.ai>

* docs(readme): regroup features around the team arc, drop project status (MUL-5812)

Co-authored-by: multica-agent <github@multica.ai>

* docs(readme): drop the unsuitable inline screenshots from the feature sections (MUL-5812)

Co-authored-by: multica-agent <github@multica.ai>

* docs(readme): make quick start cloud/desktop-first, keep CLI for self-hosting (MUL-5812)

Co-authored-by: multica-agent <github@multica.ai>

* docs(readme): smooth out stiff Chinese phrasing across README.zh and VISION.zh (MUL-5812)

Co-authored-by: multica-agent <github@multica.ai>

* docs(readme): apply translation review — glossary terms, OS metaphor, VISION naturalization (MUL-5812)

Co-authored-by: multica-agent <github@multica.ai>

* chore(ci): drop the readme-runtimes check (MUL-5812)

Co-authored-by: multica-agent <github@multica.ai>

---------

Co-authored-by: Lambda <lambda@multica.ai>
Co-authored-by: multica-agent <github@multica.ai>
2026-08-06 18:31:53 +08:00
..