Skip to content

docs: 新增 Loomy「AI 搭子」「办公 CLI 集成」并补全自定义模型配置#50

Merged
FenjuFu merged 2 commits into
mainfrom
docs/loomy-companions-office-cli
Jun 16, 2026
Merged

docs: 新增 Loomy「AI 搭子」「办公 CLI 集成」并补全自定义模型配置#50
FenjuFu merged 2 commits into
mainfrom
docs/loomy-companions-office-cli

Conversation

@FenjuFu

@FenjuFu FenjuFu commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

背景

对照从 https://loomy.xunfei.cn/docs 爬取的完整文档,逐节比对站点现有内容,补全缺失的章节,并把对应截图从官方文档搬到本地。

新增/变更内容

内容 处理 配图
AI 搭子(Companions) 新建 companions.md(中/英) 14 张
办公 CLI 集成(飞书/钉钉/企业微信 CLI) 新建 office-cli.md(中/英) 20 张
自定义模型详解(智谱示例、生图模型配置、验证步骤) 扩充 models.md 原有简版(中/英) 10 张
  • 办公 CLI 在文中明确与"远程控制机器人"作区分:前者让 Loomy 直接读写飞书/钉钉/企业微信业务数据,后者是手机远程触发本地任务,避免与现有"接入机器人"页面混淆。
  • 侧边栏中英文导航各新增两个入口。

图片

  • 44 张截图全部从官方文档抓取,存入 docs/public/loomy/{companions,feishu-cli,dingding-cli,wecom-cli,custom-models}/,本地引用而非外链。
  • 中英文共 88 处图片引用,校验零缺失,均为有效 PNG。

验证

  • npm run docs:build 通过(VitePress 死链检查无报错)
  • 搜索索引 docs-index.json 已重新生成(257 → 315 chunks)

Related to #17.

- 新增 AI 搭子(companions)页面,含默认搭子、模板搭子、自定义搭子等说明
- 新增办公 CLI 集成(office-cli)页面,覆盖飞书/钉钉/企业微信 CLI
- 扩充模型页自定义模型配置(智谱示例、生图模型、验证)
- 中英文双语同步,新增配套截图,更新侧边栏导航与文档搜索索引
@vercel

vercel Bot commented Jun 16, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
astronclaw-tutorial Ready Ready Preview, Comment Jun 16, 2026 7:14am

Request Review

@FenjuFu

FenjuFu commented Jun 16, 2026

Copy link
Copy Markdown
Contributor Author

C:/Program Files/Git/gemini review

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

本 PR 按照 Loomy 官方文档补全站点缺失章节:新增「AI 搭子」「办公 CLI 集成」两篇中英页面,并显著扩充「自定义模型配置」的中英说明;同时更新侧边栏导航与站内搜索索引(docs-index.json)以覆盖新增内容与图片资源。

Changes:

  • 新增 Loomy 文档页:companions.mdoffice-cli.md(中/英)
  • 扩充 models.md(中/英):补全自定义模型(OpenAI 协议)配置、图像生成模型与验证步骤、FAQ
  • 更新 VitePress 侧边栏入口与 docs-index.json 搜索索引内容

Reviewed changes

Copilot reviewed 7 out of 52 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
docs/public/docs-index.json 重新生成/更新知识库索引,加入新章节内容并调整部分换行格式
docs/guide/loomy/office-cli.md 新增中文「办公 CLI 集成」文档页(飞书/钉钉/企业微信)
docs/guide/loomy/models.md 扩充中文自定义模型配置与验证/FAQ
docs/guide/loomy/companions.md 新增中文「AI 搭子」文档页
docs/en/guide/loomy/office-cli.md 新增英文「Office CLI Integration」文档页
docs/en/guide/loomy/models.md 扩充英文自定义模型配置与验证/FAQ
docs/en/guide/loomy/companions.md 新增英文「AI Companions」文档页
docs/.vitepress/config.mts 侧边栏新增「AI 搭子 / Office CLI」入口(中/英)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/guide/loomy/models.md Outdated
Comment thread docs/guide/loomy/office-cli.md Outdated
Comment thread docs/guide/loomy/office-cli.md Outdated
Comment thread docs/en/guide/loomy/office-cli.md Outdated

The DingTalk CLI is integrated into Loomy through the MCP protocol, covering DingTalk's core business domains so that AI can complete DingTalk-related work directly in conversation, supporting messaging, document collaboration, schedule management, to-do tasks, and more.

### Pre-use Checks
Comment thread docs/en/guide/loomy/office-cli.md Outdated

![Complete WeCom CLI initialization following the terminal prompts](/loomy/wecom-cli/terminal-init.png)

### Pre-use Checks
Comment thread docs/public/docs-index.json Outdated
@@ -1177,7 +1467,7 @@
{
"lang": "en",
"heading": "What are points used for",
"content": "Points are mainly used to support Loomy's resource consumption during task execution, including but not limited to default model calls, task processing, and the use of some high-value capabilities.\r\n\r\n**Are points deducted when using custom models?**\r\nIf you configure and use your own AI model service provider API Key in Loomy, related model calls usually will not consume Loomy points.\nThat is to say:\r\n* When using the default model service provided by Loomy, points will be consumed according to corresponding rules\r\n* When using your own configured model service provider, the model call itself will not deduct Loomy points\r\n\r\nWhether it involves the consumption of other capabilities is subject to the current rules and actual function descriptions within the product.\r\n\r\n> **API Key Security Instructions**\r\n> The API Key you configure yourself will only be saved on your local device. Loomy will not host, upload, or leak this key information.\n> **Keep your keys safe**: API Keys are sensitive information. Do not share them casually, and do not save or transmit them in untrusted environments. If a key is leaked, a third party may misuse your model service quota or access capabilities."
"content": "Points are mainly used to support Loomy's resource consumption during task execution, including but not limited to default model calls, task processing, and the use of some high-value capabilities.\r\n\r\n**Are points deducted when using custom models?**\r\nIf you configure and use your own AI model service provider API Key in Loomy, related model calls usually will not consume Loomy points.\r\nThat is to say:\r\n* When using the default model service provided by Loomy, points will be consumed according to corresponding rules\r\n* When using your own configured model service provider, the model call itself will not deduct Loomy points\r\n\r\nWhether it involves the consumption of other capabilities is subject to the current rules and actual function descriptions within the product.\r\n\r\n> **API Key Security Instructions**\r\n> The API Key you configure yourself will only be saved on your local device. Loomy will not host, upload, or leak this key information.\r\n> **Keep your keys safe**: API Keys are sensitive information. Do not share them casually, and do not save or transmit them in untrusted environments. If a key is leaked, a third party may misuse your model service quota or access capabilities."
- generate-index.js 统一换行为 \n,消除索引中残留的 \r(CRLF 归一化)
- 办公 CLI 页中英文的「使用前检查/使用场景」加平台前缀,避免重复标题导致大纲锚点歧义
- 统一中文模型页 FAQ 术语「最大输出 Tokens」
@FenjuFu

FenjuFu commented Jun 16, 2026

Copy link
Copy Markdown
Contributor Author

已处理 @copilot 的 review 意见(commit 2d498a4):

  1. 索引 CRLF:在 scripts/generate-index.js 读取文件后统一 \r\n?\n,重新生成的 docs-index.json 已不含残留 \r
  2. 重复三级标题office-cli.md(中/英)的「使用前检查 / 使用场景」「Pre-use Checks / Use Cases」均加上平台前缀(飞书/钉钉/企业微信),消除大纲锚点歧义。
  3. 术语统一:中文模型页 FAQ 统一为「最大输出 Tokens」。

npm run docs:build 通过,死链检查无报错。

@FenjuFu

FenjuFu commented Jun 16, 2026

Copy link
Copy Markdown
Contributor Author

/gemini review

@FenjuFu FenjuFu merged commit e8c753b into main Jun 16, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants