Onboarding and Config Protocol

这页说明书讲的是一个“设置小助手”的工作方式。你可以把它想成一个会说话的机器人，它负责在你第一次用软件时，问你几个简单的问题，帮你把一切都准备好。最棒的是，不管你在哪里打开这个软件（比如用键盘打命令、用苹果电脑的软件，或者用网页），你遇到的都是同一个机器人，它会用同样的方式和你聊天。

这个“小助手”系统是由几个部分一起工作的：

1. 向导引擎：这是小助手的大脑。它记得和你聊到哪了，要问你什么问题，还有你现在设置到哪一步了。
2. 命令行（CLI）：就是那个用键盘打字来操作软件的黑窗口。它现在也用上了和图形界面一样的小助手流程。
3. 网关（Gateway RPC）：你可以把它想成小助手的“电话总机”。其他部分（比如软件界面）想找小助手帮忙，都要先打这个电话。
4. 苹果电脑软件和网页界面：它们会按照小助手电话里说的，把需要你填写的表格画出来给你看。

如果你想通过“电话总机”（Gateway RPC）找小助手帮忙，可以打下面这些电话：

• wizard.start：打电话说“小助手，开始工作吧！”。你可以告诉它你想在“本地”还是“远程”模式玩，还可以选一个“工作区”。
• wizard.next：告诉小助手“我答完这一步了，下一步是什么？”。你需要告诉它你们聊天的编号（sessionId），还有你刚才的答案。
• wizard.cancel：打电话说“算了，我不玩了，结束聊天吧”。同样需要聊天编号。
• wizard.status：打电话问“小助手，我们聊到哪一步了？”。需要聊天编号。
• config.schema：打电话问“把需要我填的所有表格都给我看看”。
• config.schema.lookup：打电话问“我只想看看某个小表格，比如某个小插件（plugin）的设置”。你需要告诉它表格的路径（path）。

小助手或者表格系统会这样回答你：

• 关于向导聊天：会告诉你聊天编号、是否结束了、下一步该做什么、现在状态如何，或者有没有出错。
• 关于配置表格：会给你表格的详细规则（schema）、一些让表格更好看的提示（uiHints）、版本号和生成时间。
• 关于查找小表格：会告诉你找的是哪个路径、那个小表格的规则，可能还有提示和它下面的小项目。

为了让表格更好看、更友好，系统会用 uiHints 来给每个设置项加“小贴纸”，比如：

• 给它起个好懂的名字（label）。
• 加一段说明告诉你它是干嘛的（help）。
• 把相关的设置项放在一组（group）。
• 决定谁先谁后（order）。
• 标记这个设置是不是给高级玩家看的（advanced）。
• 标记这个设置是不是秘密，比如密码（sensitive）。如果是秘密，输入框会变成小黑点。
• 在空框里放个例子（placeholder）。

这里要小心两件事哦：

1. 被标记为“秘密”（sensitive）的输入框，只会显示成小黑点，但系统不会帮你把里面的内容藏起来或加密，所以你自己要保管好密码。
2. 如果某个设置太复杂，超出了系统能画出来的表格范围，它就会直接给你一个空白的 JSON 编辑器让你自己写代码，那个看起来会有点难。

最后记住，如果你想了解这个“小助手”和“设置表格”系统以后有什么大改动，就看这一页说明书，它是记录所有变化的大本营。