Skip to content

armgit / cindy

Public Imported from GitHub
0

Consider it done. The open-source AI agent that works out of the box · 想到,就能做到。开源、开箱即用的 AI Agent。

docs(help): 同步语言通知与外观设置说明

Cindy9349de066a65
diff --git a/apps/desktop/help-knowledge/appearance.md b/apps/desktop/help-knowledge/appearance.md
index 13134141a4..316ef454f4 100644
--- a/apps/desktop/help-knowledge/appearance.md
+++ b/apps/desktop/help-knowledge/appearance.md
@@ -11,7 +11,8 @@ Settings > General controls how the app looks and how it notifies you.
- **Theme**: light, dark, or system (follows your OS).
- **Theme family**: pick from the registered theme families; each family supplies its own colors for light and dark. The app uses a VSCode-style token system (see docs/design-rules/cindy-design-system.md) so themes only override what they need.
-- **Fonts and sidebar density**: the same section also has UI / code font-family pickers with font-size sliders, and a selector for the sidebar's session card mode.
+- **Fonts**: choose fonts and sizes for interface text and code. Code font size changes code blocks, change comparisons, and editors; inline code, status numbers, badges, and path labels keep their size.
+- **Pinned Style**: show pinned sessions as Text, Cards, or List. **List Style** controls unpinned sessions: Text uses one line; List adds a preview.
- **Local theme brand identity**: this is an optional power-user feature configured in the local theme JSON. The settings page intentionally keeps only create-copy, open-folder, and refresh actions. New copies include self-explanatory example paths directly in the JSON.
- **Export / open local theme files**: export the current theme's tokens to a file or open a local theme JSON for inspection / sharing. To replace the icon and logo used on the new-chat page:
@@ -28,11 +29,11 @@ Settings > General controls how the app looks and how it notifies you.
**Language:**
-- Display language: System / English / 简体中文 / 繁體中文 / 日本語 / 한국어. Affects UI text only; agent replies follow your prompt and personalization, not this setting.
+- Display language: System / English / 简体中文 / 繁體中文 / 日本語 / 한국어. Used for the interface and AI error reports. Other replies follow your message or language request. On mobile, the phone's display language is used for AI error reports for messages sent from that phone.
**Notifications:**
-- **Desktop notification on session finished** — OS-level ping when an agent completes its reply.
+- **System Notifications** — notify when a session finishes, encounters an error, or needs a reply. Regular sessions notify only while the window is in the background. When Agent Island is enabled, it handles these alerts instead.
- **FeiShu DM on session finished** — requires the FeiShu bot to be configured (see the FeiShu bot topic).
**Notes:**
diff --git a/apps/desktop/help-knowledge/feishu-bot.md b/apps/desktop/help-knowledge/feishu-bot.md
index 207c2768da..d5b9058ff4 100644
--- a/apps/desktop/help-knowledge/feishu-bot.md
+++ b/apps/desktop/help-knowledge/feishu-bot.md
@@ -19,7 +19,7 @@ Cindy can send DMs and take commands through a FeiShu (Lark) bot. (This is unrel
**Notifications:**
- Toggle **message notifications** on the same page to get bot DMs when sessions finish, or when the bot has updates for you.
-- The desktop-OS-level "session finished" notification is a separate toggle in **Settings > General > Notifications**.
+- **System Notifications** is a separate toggle in **Settings > General > Notifications**. It covers sessions finishing, encountering an error, or needing a reply. See the appearance topic for background-window and Agent Island behavior.
**Group chats:**
diff --git a/apps/desktop/src/main/maker-ipc/helpKnowledge.generated.ts b/apps/desktop/src/main/maker-ipc/helpKnowledge.generated.ts
index 796f8e4dbb..95c67f6616 100644
--- a/apps/desktop/src/main/maker-ipc/helpKnowledge.generated.ts
+++ b/apps/desktop/src/main/maker-ipc/helpKnowledge.generated.ts
@@ -16,7 +16,7 @@ export const HELP_KNOWLEDGE: HelpKnowledgeDoc[] = [
title: "Appearance, theme, language and notifications",
summary: "Theme, theme family, fonts, display language, and desktop / FeiShu notifications — all in Settings > General.",
tab: "general",
- content: "Settings > General controls how the app looks and how it notifies you.\n\n**Appearance:**\n\n- **Theme**: light, dark, or system (follows your OS).\n- **Theme family**: pick from the registered theme families; each family supplies its own colors for light and dark. The app uses a VSCode-style token system (see docs/design-rules/cindy-design-system.md) so themes only override what they need.\n- **Fonts and sidebar density**: the same section also has UI / code font-family pickers with font-size sliders, and a selector for the sidebar's session card mode.\n- **Local theme brand identity**: this is an optional power-user feature configured in the local theme JSON. The settings page intentionally keeps only create-copy, open-folder, and refresh actions. New copies include self-explanatory example paths directly in the JSON.\n- **Export / open local theme files**: export the current theme's tokens to a file or open a local theme JSON for inspection / sharing. To replace the icon and logo used on the new-chat page:\n\n ```json\n {\n \"brand\": {\n \"icon\": \"/absolute/path/to/your-image-folder/icon-square-50x50px.png\",\n \"logo\": \"/absolute/path/to/your-image-folder/logo-horizontal-110x37.5px.png\"\n }\n }\n ```\n\n The example filenames describe the final display areas; source images may be exported at 2x/3x while keeping the same aspect ratios. Paths must be absolute JSON strings; spaces do not need shell quotes. PNG, JPEG, and WebP are supported. Transparent padding is trimmed at render time without changing the source file. Only `brand.icon` and `brand.logo` are recognized; the previous single-image fields are not compatible with the redesigned two-asset layout.\n\n**Language:**\n\n- Display language: System / English / 简体中文 / 繁體中文 / 日本語 / 한국어. Affects UI text only; agent replies follow your prompt and personalization, not this setting.\n\n**Notifications:**\n\n- **Desktop notification on session finished** — OS-level ping when an agent completes its reply.\n- **FeiShu DM on session finished** — requires the FeiShu bot to be configured (see the FeiShu bot topic).\n\n**Notes:**\n\n- Theme changes apply immediately; no restart needed.\n- Language changes apply immediately, but a few static strings may need a window reload to update.",
+ content: "Settings > General controls how the app looks and how it notifies you.\n\n**Appearance:**\n\n- **Theme**: light, dark, or system (follows your OS).\n- **Theme family**: pick from the registered theme families; each family supplies its own colors for light and dark. The app uses a VSCode-style token system (see docs/design-rules/cindy-design-system.md) so themes only override what they need.\n- **Fonts**: choose fonts and sizes for interface text and code. Code font size changes code blocks, change comparisons, and editors; inline code, status numbers, badges, and path labels keep their size.\n- **Pinned Style**: show pinned sessions as Text, Cards, or List. **List Style** controls unpinned sessions: Text uses one line; List adds a preview.\n- **Local theme brand identity**: this is an optional power-user feature configured in the local theme JSON. The settings page intentionally keeps only create-copy, open-folder, and refresh actions. New copies include self-explanatory example paths directly in the JSON.\n- **Export / open local theme files**: export the current theme's tokens to a file or open a local theme JSON for inspection / sharing. To replace the icon and logo used on the new-chat page:\n\n ```json\n {\n \"brand\": {\n \"icon\": \"/absolute/path/to/your-image-folder/icon-square-50x50px.png\",\n \"logo\": \"/absolute/path/to/your-image-folder/logo-horizontal-110x37.5px.png\"\n }\n }\n ```\n\n The example filenames describe the final display areas; source images may be exported at 2x/3x while keeping the same aspect ratios. Paths must be absolute JSON strings; spaces do not need shell quotes. PNG, JPEG, and WebP are supported. Transparent padding is trimmed at render time without changing the source file. Only `brand.icon` and `brand.logo` are recognized; the previous single-image fields are not compatible with the redesigned two-asset layout.\n\n**Language:**\n\n- Display language: System / English / 简体中文 / 繁體中文 / 日本語 / 한국어. Used for the interface and AI error reports. Other replies follow your message or language request. On mobile, the phone's display language is used for AI error reports for messages sent from that phone.\n\n**Notifications:**\n\n- **System Notifications** — notify when a session finishes, encounters an error, or needs a reply. Regular sessions notify only while the window is in the background. When Agent Island is enabled, it handles these alerts instead.\n- **FeiShu DM on session finished** — requires the FeiShu bot to be configured (see the FeiShu bot topic).\n\n**Notes:**\n\n- Theme changes apply immediately; no restart needed.\n- Language changes apply immediately, but a few static strings may need a window reload to update.",
},
{
id: "attachments",
@@ -47,7 +47,7 @@ export const HELP_KNOWLEDGE: HelpKnowledgeDoc[] = [
title: "Setting up the FeiShu (Lark) bot",
summary: "Configure the FeiShu bot (App ID / App Secret) in Settings > IM bots to get DM notifications and bot interaction.",
tab: "im-bot",
- content: "Cindy can send DMs and take commands through a FeiShu (Lark) bot. (This is unrelated to signing into Cindy — you sign in with your Cindy account; FeiShu is no longer a login method.)\n\n**Setting up the bot:**\n\n- Open Settings > IM bots, then the FeiShu Bot section.\n- Paste the bot's **App ID** and **App Secret**, then click **Bind**.\n- The status badge updates: **needs-config** → **connecting** → **connected** (or **conflict** / **error**).\n\n**Binding the bot to you:**\n\n- After the badge shows **connected**, the page instructs you to DM the bot a code (or click an action) to complete the binding. Until you bind, the bot won't know which FeiShu user to DM.\n\n**Notifications:**\n\n- Toggle **message notifications** on the same page to get bot DMs when sessions finish, or when the bot has updates for you.\n- The desktop-OS-level \"session finished\" notification is a separate toggle in **Settings > General > Notifications**.\n\n**Group chats:**\n\n- In a group, @ the bot to ask a question. The bot opens a new thread (话题) for the reply — the main stream stays clean and each thread is its own session, like Slack threads.\n- The bot pages back through recent chat history (newest first, until the messages stop being relevant to your question) and answers with that history as context — including images and files shared in the chat. For a fresh thread opened from the main stream, the context still comes from the main stream history.\n- @-ing the bot inside an existing thread uses that thread's own history as context.\n- Thread sessions are titled `[飞书·{group name}·{topic summary}] {id suffix}` in the sidebar.\n\n**Permissions for group features:**\n\nGroup chat context needs an extra app permission that is not part of the default setup:\n\n1. Open the **FeiShu (Lark) Open Platform** → Developer Console → your app → **Permissions & Scopes** (权限管理).\n2. Search for and enable **both** of the following (searching by the scope id works regardless of the console language):\n - **\"Read all messages in associated group chat\" (获取群组中所有消息, `im:message.group_msg`)** — pulls the chat history via API.\n - **\"Read user and bot messages in group chats\" (获取群组中用户和机器人消息, `im:message.group_msg.include_bot:read`)** — needed for group message events, so the history covers messages from other bots too.\n These are sensitive permissions: on FeiShu they are only available to self-built apps (自建应用), not store apps.\n3. Create and publish a new app **version** (self-built apps need admin approval).\n\nWithout it the bot still answers when @-ed, but with no chat context, and it DMs the owner a one-line heads-up pointing here. Optionally, enabling **\"Obtain basic group information\" (获取群基本信息, `im:chat:readonly`)** lets session titles show the real group name instead of an id suffix.\n\n**Notes:**\n\n- The \"conflict\" badge state means another Cindy instance is already bound to the same bot for this user — typical when running dev + release simultaneously. Disconnect on one side to clear it.\n- Settings > IM bots also hosts the Slack and Telegram bindings (the \"Cindy\" tab) and a bring-your-own Discord bot, alongside this FeiShu bot.",
+ content: "Cindy can send DMs and take commands through a FeiShu (Lark) bot. (This is unrelated to signing into Cindy — you sign in with your Cindy account; FeiShu is no longer a login method.)\n\n**Setting up the bot:**\n\n- Open Settings > IM bots, then the FeiShu Bot section.\n- Paste the bot's **App ID** and **App Secret**, then click **Bind**.\n- The status badge updates: **needs-config** → **connecting** → **connected** (or **conflict** / **error**).\n\n**Binding the bot to you:**\n\n- After the badge shows **connected**, the page instructs you to DM the bot a code (or click an action) to complete the binding. Until you bind, the bot won't know which FeiShu user to DM.\n\n**Notifications:**\n\n- Toggle **message notifications** on the same page to get bot DMs when sessions finish, or when the bot has updates for you.\n- **System Notifications** is a separate toggle in **Settings > General > Notifications**. It covers sessions finishing, encountering an error, or needing a reply. See the appearance topic for background-window and Agent Island behavior.\n\n**Group chats:**\n\n- In a group, @ the bot to ask a question. The bot opens a new thread (话题) for the reply — the main stream stays clean and each thread is its own session, like Slack threads.\n- The bot pages back through recent chat history (newest first, until the messages stop being relevant to your question) and answers with that history as context — including images and files shared in the chat. For a fresh thread opened from the main stream, the context still comes from the main stream history.\n- @-ing the bot inside an existing thread uses that thread's own history as context.\n- Thread sessions are titled `[飞书·{group name}·{topic summary}] {id suffix}` in the sidebar.\n\n**Permissions for group features:**\n\nGroup chat context needs an extra app permission that is not part of the default setup:\n\n1. Open the **FeiShu (Lark) Open Platform** → Developer Console → your app → **Permissions & Scopes** (权限管理).\n2. Search for and enable **both** of the following (searching by the scope id works regardless of the console language):\n - **\"Read all messages in associated group chat\" (获取群组中所有消息, `im:message.group_msg`)** — pulls the chat history via API.\n - **\"Read user and bot messages in group chats\" (获取群组中用户和机器人消息, `im:message.group_msg.include_bot:read`)** — needed for group message events, so the history covers messages from other bots too.\n These are sensitive permissions: on FeiShu they are only available to self-built apps (自建应用), not store apps.\n3. Create and publish a new app **version** (self-built apps need admin approval).\n\nWithout it the bot still answers when @-ed, but with no chat context, and it DMs the owner a one-line heads-up pointing here. Optionally, enabling **\"Obtain basic group information\" (获取群基本信息, `im:chat:readonly`)** lets session titles show the real group name instead of an id suffix.\n\n**Notes:**\n\n- The \"conflict\" badge state means another Cindy instance is already bound to the same bot for this user — typical when running dev + release simultaneously. Disconnect on one side to clear it.\n- Settings > IM bots also hosts the Slack and Telegram bindings (the \"Cindy\" tab) and a bring-your-own Discord bot, alongside this FeiShu bot.",
},
{
id: "getting-started",