mirror of https://github.com/multica-ai/multica.git synced 2026-08-02 18:13:27 +02:00

Files

Naiyuan Qing e395fb8744 docs: four-language documentation overhaul with verified facts and product screenshots (MUL-5057) (#5714 )

Complete rework of the docs site, in three passes squashed into one change:

1. P0 fact corrections across the core-loop pages (agent access model,
   comment triggers and coalescing, issue lifecycle, offline/queue
   semantics, task states and retries, dispatch via realtime push).
2. Chinese rewrite as the authoring language: final 12-group IA, new
   "Core concepts" and "Put agents to work" pages, curated welcome page,
   permanent-UI quickstart (no onboarding-wizard dependency), operator
   reference restored (CLI command reference, webhook response codes,
   task state/timeout tables, config set keys, upgrade notes).
3. Verification and sync: every load-bearing claim re-checked against
   current main with file:line evidence (migration 103 auto-backfill,
   CLI-only trigger toggling, duplication semantics, COOKIE_DOMAIN,
   GitHub App variables, Qwen Code as the 17th provider); register
   standards applied to all 39 pages; en/ja/ko synced from zh with
   same-language heading anchors (verified, zero dead links);
   17 product screenshots plus 2 diagrams wired in.

Supporting fixes: i18n middleware no longer swallows /images assets,
sidebar folder indent survives custom link padding, unused editorial
components removed.

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>

2026-07-30 14:09:41 +08:00

3.5 KiB

Raw Permalink Blame History

Multica 中文文档优化计划

状态：中文正文与目录已完成，产品截图待逐步补充。

工作目录：/Users/qingnaiyuan/Desktop/work/multica-pr-5714

目标

让第一次接触 Multica 的用户能够：

直接理解 Multica 是什么，以及人和智能体如何共同工作。
按一条明确路径完成第一次智能体执行。
明白 Multica、连接电脑、运行时和 AI 编程工具之间的关系。
根据产品中的真实概念找到后续功能、集成和运维说明。

中文版本先完成并评审。英文、日文和韩文在中文结构稳定后再同步，避免四种语言反复返工。

当前信息架构

开始使用
├─ 欢迎
├─ 快速上手
├─ Multica 是怎么工作的
└─ 自托管快速上手

工作区与团队
├─ 工作区
└─ 成员与权限

Issue 与项目
├─ Issues
├─ 项目
└─ 项目资源

智能体
├─ 智能体
├─ 创建和配置智能体
├─ Skills
└─ 小队

日常协作
├─ 把 Issue 分配给智能体
├─ 评论
├─ 通过评论调用智能体
├─ 与智能体对话
└─ 收件箱与订阅

自动化与集成
├─ 自动化
├─ 聊天集成
├─ GitHub 集成
├─ 飞书 Bot
└─ Slack Bot

运行时与执行
├─ 执行任务
├─ 守护进程与运行时
├─ 安装 AI 编程工具
└─ AI 编程工具对照

自托管与管理
├─ 环境变量
├─ 登录与注册
└─ 故障排查

客户端与 CLI
├─ 桌面应用
├─ 移动 App（iOS）
├─ 使用 CLI
└─ 认证与令牌

开发者
├─ 参与开发
├─ 项目架构
└─ 开发规范

目前共有 37 篇中文页面，全部进入 sidebar。旧版重复页面已经移除，并通过永久重定向保留旧链接。

写作原则

一篇页面只解决一个主要问题。
先说明用户要做什么，再补充原理和边界。
使用产品中的真实概念，避免宣传性排比和抽象口号。
issue、skill 和 task 按中文术语规范使用；工作区、智能体、项目、自动化、守护进程和运行时使用中文。
涉及权限、安全、失败和重试时，写清具体边界，不做绝对承诺。
操作教程给出成功标志和排查入口；参考页面保留可查阅的参数、命令和状态。

图片计划

图片不阻塞中文正文定稿，后续按页面逐张确认。

优先补充：

Welcome：人和多个智能体在同一工作区协作的真实产品画面。
Quickstart：运行时选择、Multica Helper 入门选项、issue 执行结果。
其余操作页：只有当截图能明显减少文字说明时才添加。

产品操作使用真实 UI 截图；架构和对象关系使用 React/CSS 或 SVG。图片不承担正文中没有出现的关键信息，并提供准确的 alt text。

已完成的验证

37/37 篇中文页面均在 sidebar 中。
所有中文站内链接和标题锚点均可解析。
旧版中文 URL 会重定向到对应的新页面。
37 个中文路由在本地开发站均返回 200。
pnpm --filter @multica/docs typecheck 通过。
pnpm --filter @multica/docs test 通过，17 个测试全部成功。
pnpm --filter @multica/docs build 通过，147 个静态页面生成成功。

后续顺序

在 http://localhost:4000/docs/zh 逐页评审中文文案和页面节奏。
按教学价值逐张替换截图占位。
检查截图的移动端、深浅色和 alt text。
中文内容完全确认后，同步英文、日文和韩文。

3.5 KiB Raw Permalink Blame History Unescape Escape