From f10ad3e344b90f83b8a826c20251fff73ff16839 Mon Sep 17 00:00:00 2001 From: Yanbo Wang Date: Mon, 5 Oct 2026 23:22:11 +0800 Subject: [PATCH 1/2] =?UTF-8?q?docs:=20client-first=20corrections=20?= =?UTF-8?q?=E2=80=94=20nav,=20Apps=20model,=20use-case=20chapters,=20Deplo?= =?UTF-8?q?yment=20group?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Addresses the post-#9 feedback round: - Nav: Guides / Use Cases / Help Center; Integrations (dead entry) and About removed - Sidebar: Deployment group restored (Server Deploy, Workspace Backends, Connectors); TTS: Edge and Memory: Mem0/OpenViking entries removed, Memory: Built-in renamed to Memory; Preferences page deleted - Use Cases: split from one page into docs/use-cases/ with one chapter per scenario, with placeholders marking where real screenshots/recordings belong - Supermarket & Skills: rewritten around the unified App concept (an App bundles Skills, dependencies, connectors); Skills now documents workspace directories (/data/skills/user/personal/...) instead of the removed management UI - Workspace: rewritten against the client; backend config and CDI/GPU passthrough moved to self-hosted Workspace Backends; Connectors moved to self-hosted - All inbound links fixed; locale parity 89/89 pages, 47/47 sidebar links; vitepress build passes with dead-link checking on Co-Authored-By: Claude Fable 5 --- README.md | 15 +- README_CN.md | 15 +- docs/.vitepress/config.ts | 6 +- docs/.vitepress/en.ts | 28 ++- docs/.vitepress/theme/components/DocsHome.vue | 4 +- docs/.vitepress/zh.ts | 26 ++- docs/guides/connectors.md | 72 -------- docs/guides/container.md | 134 ++++----------- docs/guides/extensions.md | 8 +- docs/guides/index.md | 5 +- docs/guides/overview.md | 4 +- docs/guides/preferences.md | 100 ----------- docs/guides/quick-start.md | 4 +- docs/guides/skills.md | 160 +++--------------- docs/guides/supermarket.md | 50 +++--- docs/guides/use-cases.md | 109 ++---------- docs/guides/working-with-bots.md | 7 +- docs/integrations/index.md | 1 - docs/integrations/providers/llm.md | 10 +- docs/integrations/providers/memory/mem0.md | 45 ----- .../providers/memory/openviking.md | 43 ----- docs/integrations/providers/tts/edge.md | 44 ----- docs/memory-providers/mem0.md | 16 -- docs/memory-providers/openviking.md | 16 -- docs/self-hosted/connectors.md | 56 ++++++ docs/self-hosted/docker.md | 8 +- docs/self-hosted/workspace-backends.md | 28 +++ docs/tts-providers/edge.md | 16 -- docs/tts-providers/index.md | 16 -- docs/use-cases/code-and-preview.md | 17 ++ docs/use-cases/data-upkeep.md | 17 ++ docs/use-cases/gated-web-tasks.md | 17 ++ docs/use-cases/group-duty-assistant.md | 17 ++ docs/use-cases/index.md | 25 +++ docs/use-cases/morning-briefing.md | 17 ++ docs/use-cases/personal-assistant.md | 17 ++ docs/use-cases/release-watch.md | 17 ++ docs/zh/guides/connectors.md | 72 -------- docs/zh/guides/container.md | 130 ++++---------- docs/zh/guides/extensions.md | 8 +- docs/zh/guides/index.md | 5 +- docs/zh/guides/overview.md | 4 +- docs/zh/guides/preferences.md | 100 ----------- docs/zh/guides/quick-start.md | 4 +- docs/zh/guides/skills.md | 123 +++----------- docs/zh/guides/supermarket.md | 48 +++--- docs/zh/guides/use-cases.md | 109 ++---------- docs/zh/guides/working-with-bots.md | 7 +- docs/zh/integrations/index.md | 1 - docs/zh/integrations/providers/llm.md | 10 +- docs/zh/integrations/providers/memory/mem0.md | 36 ---- .../providers/memory/openviking.md | 34 ---- docs/zh/integrations/providers/tts/edge.md | 40 ----- docs/zh/memory-providers/mem0.md | 16 -- docs/zh/memory-providers/openviking.md | 16 -- docs/zh/self-hosted/connectors.md | 56 ++++++ docs/zh/self-hosted/docker.md | 8 +- docs/zh/self-hosted/workspace-backends.md | 28 +++ docs/zh/tts-providers/edge.md | 16 -- docs/zh/tts-providers/index.md | 16 -- docs/zh/use-cases/code-and-preview.md | 17 ++ docs/zh/use-cases/data-upkeep.md | 17 ++ docs/zh/use-cases/gated-web-tasks.md | 17 ++ docs/zh/use-cases/group-duty-assistant.md | 17 ++ docs/zh/use-cases/index.md | 25 +++ docs/zh/use-cases/morning-briefing.md | 17 ++ docs/zh/use-cases/personal-assistant.md | 17 ++ docs/zh/use-cases/release-watch.md | 17 ++ 68 files changed, 753 insertions(+), 1468 deletions(-) delete mode 100644 docs/guides/connectors.md delete mode 100644 docs/guides/preferences.md delete mode 100644 docs/integrations/providers/memory/mem0.md delete mode 100644 docs/integrations/providers/memory/openviking.md delete mode 100644 docs/integrations/providers/tts/edge.md delete mode 100644 docs/memory-providers/mem0.md delete mode 100644 docs/memory-providers/openviking.md create mode 100644 docs/self-hosted/connectors.md delete mode 100644 docs/tts-providers/edge.md delete mode 100644 docs/tts-providers/index.md create mode 100644 docs/use-cases/code-and-preview.md create mode 100644 docs/use-cases/data-upkeep.md create mode 100644 docs/use-cases/gated-web-tasks.md create mode 100644 docs/use-cases/group-duty-assistant.md create mode 100644 docs/use-cases/index.md create mode 100644 docs/use-cases/morning-briefing.md create mode 100644 docs/use-cases/personal-assistant.md create mode 100644 docs/use-cases/release-watch.md delete mode 100644 docs/zh/guides/connectors.md delete mode 100644 docs/zh/guides/preferences.md delete mode 100644 docs/zh/integrations/providers/memory/mem0.md delete mode 100644 docs/zh/integrations/providers/memory/openviking.md delete mode 100644 docs/zh/integrations/providers/tts/edge.md delete mode 100644 docs/zh/memory-providers/mem0.md delete mode 100644 docs/zh/memory-providers/openviking.md create mode 100644 docs/zh/self-hosted/connectors.md delete mode 100644 docs/zh/tts-providers/edge.md delete mode 100644 docs/zh/tts-providers/index.md create mode 100644 docs/zh/use-cases/code-and-preview.md create mode 100644 docs/zh/use-cases/data-upkeep.md create mode 100644 docs/zh/use-cases/gated-web-tasks.md create mode 100644 docs/zh/use-cases/group-duty-assistant.md create mode 100644 docs/zh/use-cases/index.md create mode 100644 docs/zh/use-cases/morning-briefing.md create mode 100644 docs/zh/use-cases/personal-assistant.md create mode 100644 docs/zh/use-cases/release-watch.md diff --git a/README.md b/README.md index 9b95a44..2ef2aae 100644 --- a/README.md +++ b/README.md @@ -31,24 +31,25 @@ The product source code lives in [`felinics/Memoh`](https://github.com/felinics/ ## Documentation Structure -The current VitePress site is organized around three primary navigation roots: +The current VitePress site is organized around four primary navigation roots: - `docs/guides/` for product usage guides. - `docs/integrations/` for channels, providers, memory providers, TTS, and web search. -- `docs/self-hosted/` for Desktop, Server Deploy, workspace backends, Kata, and SQLite. +- `docs/self-hosted/` for Desktop, Server Deploy, workspace backends, and connectors (Connect-It). +- `docs/use-cases/` for ready-to-follow scenarios, one chapter per case. The Simplified Chinese mirror uses the same structure under `docs/zh/`: - `docs/zh/guides/` - `docs/zh/integrations/` - `docs/zh/self-hosted/` +- `docs/zh/use-cases/` Legacy paths still exist for old external links, but they are redirect pages instead of the main content source: - `docs/getting-started/` - `docs/installation/` - `docs/channels/` -- `docs/tts-providers/` - `docs/memory-providers/` - Matching Chinese redirects under `docs/zh/` @@ -94,10 +95,10 @@ pnpm preview │ ├── guides/ # Product usage guides │ ├── integrations/ # Channels and providers │ ├── self-hosted/ # Open-source deployment docs +│ ├── use-cases/ # Use-case chapters │ ├── getting-started/ # Legacy redirects to guides │ ├── installation/ # Legacy redirects to self-hosted │ ├── channels/ # Legacy redirects to integrations/channels -│ ├── tts-providers/ # Legacy redirects to integrations/providers/tts │ ├── memory-providers/ # Legacy redirects to integrations/providers/memory │ ├── public/ # Static images and logo │ ├── zh/ # Simplified Chinese documentation and redirects @@ -108,6 +109,12 @@ pnpm preview ## Changelog +### 2026-10 + +- **Client-first corrections round**: top nav is now Guides / Use Cases / Help Center (Integrations and About removed); Use Cases split into its own directory with one chapter per scenario; the Deployment sidebar group is back (Server Deploy, Workspace Backends, Connectors). +- **Apps model**: Supermarket and Skills pages rewritten around the unified App concept (an App bundles Skills, dependencies, and connectors); Skills now documents workspace directories instead of a removed management UI; Connectors moved to the Deployment section. +- **Cloud-baseline Workspace page**: open-source backend configuration and CDI/GPU passthrough moved to Workspace Backends; Preferences page removed; Memory provider entries consolidated into one; TTS: Edge removed. + ### 2026-09 - **Navigation restructure**: docs are now organized under a single **References** tree — Getting Started (with Deployment and Channels), Advanced (with Providers → Memory / TTS Providers), and Use Cases. The version selector moved to the header right, and edit links were added to every page. diff --git a/README_CN.md b/README_CN.md index b85caf0..359da64 100644 --- a/README_CN.md +++ b/README_CN.md @@ -31,24 +31,25 @@ ## 文档站结构 -当前 VitePress 文档站围绕三个主导航路径组织: +当前 VitePress 文档站围绕四个主导航路径组织: - `docs/guides/`:产品使用教程。 - `docs/integrations/`:渠道、提供方、记忆提供方、TTS 和网页搜索。 -- `docs/self-hosted/`:Desktop、Server Deploy、workspace backend、Kata 和 SQLite。 +- `docs/self-hosted/`:Desktop、Server Deploy、workspace backend 和连接器(Connect-It)。 +- `docs/use-cases/`:使用场景,每个场景独立成章。 简体中文文档使用相同结构,位于 `docs/zh/` 下: - `docs/zh/guides/` - `docs/zh/integrations/` - `docs/zh/self-hosted/` +- `docs/zh/use-cases/` 旧路径仍然保留,用于兼容外部旧链接,但它们是重定向页面,不是主要内容源: - `docs/getting-started/` - `docs/installation/` - `docs/channels/` -- `docs/tts-providers/` - `docs/memory-providers/` - `docs/zh/` 下对应的中文重定向路径 @@ -94,10 +95,10 @@ pnpm preview │ ├── guides/ # 产品使用教程 │ ├── integrations/ # 渠道和提供方 │ ├── self-hosted/ # 开源自托管部署文档 +│ ├── use-cases/ # 使用场景章节 │ ├── getting-started/ # 到 guides 的旧路径重定向 │ ├── installation/ # 到 self-hosted 的旧路径重定向 │ ├── channels/ # 到 integrations/channels 的旧路径重定向 -│ ├── tts-providers/ # 到 integrations/providers/tts 的旧路径重定向 │ ├── memory-providers/ # 到 integrations/providers/memory 的旧路径重定向 │ ├── public/ # 静态图片和 logo │ ├── zh/ # 中文文档和重定向页面 @@ -108,6 +109,12 @@ pnpm preview ## 更新日志 +### 2026-10 + +- **客户端优先修正**:顶栏改为 教程 / 使用场景 / 帮助中心(移除 集成 与 关于);使用场景拆分为独立目录、每个场景一章;侧边栏恢复自部署分组(Server Deploy、Workspace 后端、连接器)。 +- **应用(App)模型**:应用市场与技能页面按统一的 App 概念重写(一个 App 打包 Skills、依赖和连接器);技能页改为说明工作区目录,不再描述已移除的管理界面;连接器移入自部署章节。 +- **工作区页面以 Cloud 为基准**:开源后端配置与 CDI/GPU 透传移至 Workspace 后端;移除用户偏好页;记忆提供方条目合并为一个;移除 TTS: Edge。 + ### 2026-09 - **导航结构重组**:文档统一收入单一的 **References(参考文档)** 树——快速开始(内含部署与渠道)、进阶教程(内含提供方 → 记忆/TTS 提供方)、使用场景。版本选择器移到页头右侧,并为每个页面加上编辑链接。 diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 6faafe0..30dd206 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -21,9 +21,8 @@ export default defineConfig({ themeConfig: { nav: [ { text: 'Guides', link: '/guides/' }, - { text: 'Integrations', link: '/integrations/' }, + { text: 'Use Cases', link: '/use-cases/' }, { text: 'Help Center', link: 'https://memoh.ai/help' }, - { text: 'About', link: '/about.md' }, ], }, }, @@ -33,9 +32,8 @@ export default defineConfig({ themeConfig: { nav: [ { text: '教程', link: '/zh/guides/' }, - { text: '集成', link: '/zh/integrations/' }, + { text: '使用场景', link: '/zh/use-cases/' }, { text: '帮助中心', link: 'https://memoh.ai/help' }, - { text: '关于', link: '/zh/about.md' }, ], }, } diff --git a/docs/.vitepress/en.ts b/docs/.vitepress/en.ts index 5d5a71d..8a2dc08 100644 --- a/docs/.vitepress/en.ts +++ b/docs/.vitepress/en.ts @@ -11,7 +11,6 @@ const references = [ { text: 'Overview', link: '/guides/overview.md' }, { text: 'Quick Start', link: '/guides/quick-start.md' }, { text: 'Working with Bots', link: '/guides/working-with-bots.md' }, - { text: 'Preferences', link: '/guides/preferences.md' }, { text: 'Sessions', link: '/guides/sessions.md' }, { text: 'Files', link: '/guides/files.md' }, { text: 'Slash Commands', link: '/guides/slash-commands.md' }, @@ -45,25 +44,37 @@ const references = [ { text: 'Browser / Computer Use', link: '/guides/browser-computer-use.md' }, { text: 'Skills', link: '/guides/skills.md' }, { text: 'Supermarket', link: '/guides/supermarket.md' }, - { text: 'Connectors', link: '/guides/connectors.md' }, { text: 'Hooks', link: '/guides/hooks.md' }, { text: 'MCP', link: '/guides/mcp.md' }, - { text: 'Memory', link: '/guides/memory.md' }, + { text: 'Long-term Memory', link: '/guides/memory.md' }, { text: 'Compaction', link: '/guides/compaction.md' }, { text: 'Scheduled Tasks', link: '/guides/schedule.md' }, { text: 'LLM Providers', link: '/integrations/providers/llm.md' }, { text: 'Web Search Providers', link: '/integrations/providers/web-search.md' }, { text: 'Video Providers', link: '/integrations/providers/video.md' }, - { text: 'Memory: Built-in', link: '/integrations/providers/memory/builtin.md' }, - { text: 'Memory: Mem0', link: '/integrations/providers/memory/mem0.md' }, - { text: 'Memory: OpenViking', link: '/integrations/providers/memory/openviking.md' }, - { text: 'TTS: Edge', link: '/integrations/providers/tts/edge.md' }, + { text: 'Memory', link: '/integrations/providers/memory/builtin.md' }, ], }, { text: 'Use Cases', items: [ - { text: 'Use Cases', link: '/guides/use-cases.md' }, + { text: 'Overview', link: '/use-cases/' }, + { text: 'Morning Digest', link: '/use-cases/morning-briefing.md' }, + { text: 'Release Watch', link: '/use-cases/release-watch.md' }, + { text: 'Group On-Call Assistant', link: '/use-cases/group-duty-assistant.md' }, + { text: 'A Living Spreadsheet', link: '/use-cases/data-upkeep.md' }, + { text: 'Screen Work Behind Logins', link: '/use-cases/gated-web-tasks.md' }, + { text: 'Build and Preview in the Cloud', link: '/use-cases/code-and-preview.md' }, + { text: 'An Assistant That Remembers', link: '/use-cases/personal-assistant.md' }, + ], + }, + { + text: 'Deployment', + items: [ + { text: 'Overview', link: '/self-hosted/' }, + { text: 'Server Deploy', link: '/self-hosted/docker.md' }, + { text: 'Workspace Backends', link: '/self-hosted/workspace-backends.md' }, + { text: 'Connectors (Connect-It)', link: '/self-hosted/connectors.md' }, ], }, ] @@ -72,4 +83,5 @@ export const en = { '/guides/': references, '/integrations/': references, '/self-hosted/': references, + '/use-cases/': references, } diff --git a/docs/.vitepress/theme/components/DocsHome.vue b/docs/.vitepress/theme/components/DocsHome.vue index 806c5f8..dade1c1 100644 --- a/docs/.vitepress/theme/components/DocsHome.vue +++ b/docs/.vitepress/theme/components/DocsHome.vue @@ -30,7 +30,7 @@ const copy = computed(() => { icon: 'plug', title: '使用场景', text: '组合多种功能解决实际问题的即用型示例。', - href: '/zh/guides/use-cases', + href: '/zh/use-cases/', }, { tone: 'hosted', @@ -64,7 +64,7 @@ const copy = computed(() => { icon: 'plug', title: 'Use Cases', text: 'Ready-to-follow scenarios that combine features to solve real problems.', - href: '/guides/use-cases', + href: '/use-cases/', }, { tone: 'hosted', diff --git a/docs/.vitepress/zh.ts b/docs/.vitepress/zh.ts index 3ecf4a2..bd19f88 100644 --- a/docs/.vitepress/zh.ts +++ b/docs/.vitepress/zh.ts @@ -11,7 +11,6 @@ const references = [ { text: '概览', link: '/zh/guides/overview.md' }, { text: '快速开始', link: '/zh/guides/quick-start.md' }, { text: '和 Bot 协作', link: '/zh/guides/working-with-bots.md' }, - { text: '用户偏好', link: '/zh/guides/preferences.md' }, { text: '会话', link: '/zh/guides/sessions.md' }, { text: '文件', link: '/zh/guides/files.md' }, { text: '斜杠命令', link: '/zh/guides/slash-commands.md' }, @@ -45,7 +44,6 @@ const references = [ { text: 'Browser / Computer Use', link: '/zh/guides/browser-computer-use.md' }, { text: '技能', link: '/zh/guides/skills.md' }, { text: '应用市场', link: '/zh/guides/supermarket.md' }, - { text: '连接器', link: '/zh/guides/connectors.md' }, { text: 'Hooks', link: '/zh/guides/hooks.md' }, { text: 'MCP', link: '/zh/guides/mcp.md' }, { text: '长期记忆', link: '/zh/guides/memory.md' }, @@ -54,16 +52,29 @@ const references = [ { text: '模型服务商', link: '/zh/integrations/providers/llm.md' }, { text: '搜索提供方', link: '/zh/integrations/providers/web-search.md' }, { text: '视频提供方', link: '/zh/integrations/providers/video.md' }, - { text: '记忆提供方:内置', link: '/zh/integrations/providers/memory/builtin.md' }, - { text: '记忆提供方:Mem0', link: '/zh/integrations/providers/memory/mem0.md' }, - { text: '记忆提供方:OpenViking', link: '/zh/integrations/providers/memory/openviking.md' }, - { text: 'TTS:Edge', link: '/zh/integrations/providers/tts/edge.md' }, + { text: '记忆', link: '/zh/integrations/providers/memory/builtin.md' }, ], }, { text: '使用场景', items: [ - { text: '使用场景', link: '/zh/guides/use-cases.md' }, + { text: '总览', link: '/zh/use-cases/' }, + { text: '晨间简报', link: '/zh/use-cases/morning-briefing.md' }, + { text: '发版盯守', link: '/zh/use-cases/release-watch.md' }, + { text: '群聊值班助理', link: '/zh/use-cases/group-duty-assistant.md' }, + { text: '数据表格的日常维护', link: '/zh/use-cases/data-upkeep.md' }, + { text: '带登录墙的网页任务', link: '/zh/use-cases/gated-web-tasks.md' }, + { text: '云端写码与预览', link: '/zh/use-cases/code-and-preview.md' }, + { text: '记得住事的个人助理', link: '/zh/use-cases/personal-assistant.md' }, + ], + }, + { + text: '自部署', + items: [ + { text: '总览', link: '/zh/self-hosted/' }, + { text: 'Server Deploy', link: '/zh/self-hosted/docker.md' }, + { text: 'Workspace 后端', link: '/zh/self-hosted/workspace-backends.md' }, + { text: '连接器(Connect-It)', link: '/zh/self-hosted/connectors.md' }, ], }, ] @@ -72,4 +83,5 @@ export const zh = { '/zh/guides/': references, '/zh/integrations/': references, '/zh/self-hosted/': references, + '/zh/use-cases/': references, } diff --git a/docs/guides/connectors.md b/docs/guides/connectors.md deleted file mode 100644 index 764eb0a..0000000 --- a/docs/guides/connectors.md +++ /dev/null @@ -1,72 +0,0 @@ -# Connectors - -Connectors let a bot use third-party services such as GitHub or Notion. You pick a service from the Supermarket catalog, authorize it with OAuth or an API key, and bind it to a bot — from then on the bot can call that service's tools directly in conversation. - -Behind the scenes, connections are managed by [Connect-It](https://github.com/memohai/connect-it), a companion service deployed next to Memoh. All credentials (OAuth tokens, API keys) live in Connect-It; Memoh only keeps a binding record — which bot is bound to which connection, what its tool namespace is, and whether it is enabled. - ---- - -## Requirements - -Connectors are available when the server is configured with a Connect-It endpoint: - -```toml -[connect_it] -base_url = "" # e.g. "http://connect-it:8421" -api_token = "" # trusted server-to-server token -``` - -Leaving both empty disables the feature. In deployed environments, prefer the matching environment variables (`MEMOH_CONNECT_IT_BASE_URL`, `MEMOH_CONNECT_IT_API_TOKEN`). - -The one-click server deployment provisions a co-hosted Connect-It automatically on fresh installs; see [Server Deploy](../self-hosted/docker.md#connect-it-connectors). When Connect-It is not configured, the Supermarket hides the **Connectors** tab and connector operations report that connectors are not configured on this server. - ---- - -## Connect A Service - -1. Open **Supermarket** in the app. -2. Stay on the **Connectors** tab — it is the first tab and the default landing tab when connectors are configured. -3. Choose a connector and click **Connect**. -4. Select the target bot. -5. Choose an authentication method — OAuth or API key, depending on what the connector supports. -6. For OAuth, complete the authorization popup. If the browser blocks it, allow popups for the page and try again. For API keys, fill in the credential fields. -7. The connection appears in the bot's **Connectors** tab. - ---- - -## Manage Connections - -The bot detail page has a **Connectors** tab listing the bot's connected services. Each connection shows one of these statuses: - -| Status | Meaning | -|--------|---------| -| **Connected** | Active. The connection's tools are available to the bot. | -| **Waiting for authorization** | The connection was created but OAuth was never completed. Finish the authorization or disconnect it. | -| **Authorization required** | Credentials expired or were revoked. Click **Reauthorize**. | -| **Authorization failed** | The last authorization attempt did not succeed. Try **Reauthorize** again. | -| **Unavailable** | The connector is no longer available on the Connect-It side. | -| **Disabled** | Turned off. The connection's tools are not offered to the bot. | - -From the same tab you can: - -- **Enable / disable** a connection without removing it. -- **Reauthorize** a connection whose credentials went stale. -- **Disconnect** a connection — this removes the binding from the bot **and** deletes the stored connection, including its credentials, in Connect-It. - -If you abandon an OAuth authorization halfway, the connection stays in **Waiting for authorization** until you disconnect it. - ---- - -## How Tools Reach The Bot - -At conversation time, Memoh combines all of the bot's enabled, active connections into a single aggregated MCP session and offers it to the agent as a tool source. Connector tools appear alongside workspace and MCP tools. - -Each connection gets a **tool namespace** derived from the connector type when it is first bound — `github` for a GitHub connection, `github-2` for a second one. The namespace is fixed for the lifetime of the binding: connecting or disconnecting other services never renames an existing connection's tools. - ---- - -## Related Pages - -- [Supermarket](./supermarket.md) — where connectors are discovered and connected. -- [MCP](./mcp.md) — direct MCP connection management. -- [Server Deploy](../self-hosted/docker.md#connect-it-connectors) — co-hosted Connect-It provisioning, credentials, and the OAuth callback URL. diff --git a/docs/guides/container.md b/docs/guides/container.md index 65befb6..d4ca9bc 100644 --- a/docs/guides/container.md +++ b/docs/guides/container.md @@ -1,118 +1,58 @@ -# Bot Workspace Management +# Workspace -Every bot in Memoh works inside a workspace. In server deployments this is normally an isolated container, Pod, or VM-like runtime. In trusted desktop/local scenarios it may also be a local host directory. The workspace gives the bot a filesystem, command execution environment, MCP runtime, and optional graphical desktop. +Every bot has its own **workspace** — a computer that belongs to it: a real filesystem, a terminal that executes commands, a preinstalled toolchain, and optionally a visible desktop. The files you hand the bot, the results it produces, and the tools it installs all live here, preserved across sessions. -## Concept: The Bot Workspace +## What it can do -The workspace acts as the bot's private computer. Within it, the bot can: +- Store and edit files — browse them any time on the **Files** tab +- Run scripts and install packages: **Node.js** and **Python** come preinstalled (`pip` and `uv` on PATH), no interpreter setup needed +- Keep background tasks running +- Preserve state across sessions — yesterday's unfinished work continues today +- Optionally run a visible desktop with a headed browser -- store and modify files -- install software through package managers when the image allows it -- execute scripts and background tasks -- keep state across sessions -- optionally run a desktop display and headed browser +## Where it lives in the client -The workspace toolkit ships both **Node.js** and **Python** runtimes (with `pip` and `uv` on the PATH), so bots can run Python scripts and install packages without preparing an interpreter first. +Several tabs on the bot detail page face the workspace: -The underlying runtime is selected globally with `[container].backend` in `config.toml`, with trusted local workspace support controlled separately. The official Docker Compose server deploy uses `containerd`; Docker Engine, Apple, and local workspace modes are documented in [Workspace Backends](../self-hosted/workspace-backends.md). - -## Workspace tabs - -Bot detail pages expose workspace-related settings across several tabs: - -| Tab | Purpose | +| Tab | Content | |-----|---------| -| **Workspace** | Container lifecycle, snapshots, data export/import, and CDI device settings. | -| **Desktop** | Workspace display runtime, headed browser availability, live display sessions, and session cleanup. | -| **Network** | Workspace network and overlay provider status/actions. | -| **Tool Approval** | Approval settings for tools that need explicit human permission. | -| **Files** | Browse and edit the bot workspace filesystem. | -| **Terminal** | Open interactive shells inside the active workspace runtime. | - -Some tabs are hidden or limited for trusted local workspaces when the feature only applies to container-backed runtimes. - -## Container lifecycle - -Manage the container-backed workspace from the **Workspace** tab. - -- **Create**: Initialize the workspace container if it does not exist. Progress is shown through SSE during image pull and creation. -- **Start**: Launch the workspace runtime. -- **Stop**: Gracefully shut down the runtime to save resources. -- **Delete**: Remove the runtime instance. - -Many workspace features, such as terminal access and container display, require the runtime to be running. - -## Workspace display - -The **Desktop** tab prepares and inspects the graphical workspace runtime. It checks for the desktop toolkit, Xvnc/VNC availability, browser availability, and active display sessions. - -When enabled, the workspace can run a headed Chrome/Chromium browser inside the container. The app's **Desktop** pane connects to that desktop session so you and the agent can operate the same visible browser. For the tool model, see [Browser / Computer Use](./browser-computer-use.md). - -## Container information +| **Workspace** | Workspace state and lifecycle: create, start, stop; runtime info, snapshots, import/export | +| **Files** | Browse and edit the workspace filesystem | +| **Terminal** | Open an interactive shell inside the workspace | +| **Desktop** | The visible desktop: live view, take over / hand back keyboard and mouse | +| **Network** | Workspace network status | +| **Apps** | Apps installed into this workspace — skills, dependencies, connectors (see [Supermarket](./supermarket.md)) | -The **Workspace** tab displays runtime data such as: +## Lifecycle -- container ID and status -- image -- host and workspace paths -- active background tasks -- effective CDI devices, if configured +Managed from the **Workspace** tab: -## Advanced: Provide CDI Devices +- **Create**: builds a new workspace from the template, with progress shown. +- **Start / Stop**: stop it to save resources when idle — nothing is lost. +- **Delete**: removes the running instance. -Memoh can provide host devices to a bot container through CDI (Container Device Interface). This is an advanced capability for users who want to expose host-managed devices, most commonly GPUs, to the container runtime. +Most capabilities — terminal, desktop, installing and updating Apps — need the workspace **running**. The tab also shows runtime info such as state, image, and background task count. -In the app, this capability is placed under **Advanced options** in the **Workspace** tab. It is optional and only needs to be configured when the bot must access CDI-backed devices from the host. +## The visible desktop -### Configure CDI Devices +The **Desktop** tab enables and inspects the graphical desktop. Once on, the bot can drive a **headed browser** inside the workspace, and the desktop pane shows the same screen it operates: -1. Open the bot's **Workspace** tab. -2. Click **Create** if the container does not exist, or recreate the container if you need to change GPU settings. -3. Expand **Advanced options**. -4. Enable **GPU**. -5. Enter one or more CDI device names in **CDI devices**. +- Watch every step live +- **Take over** the keyboard and mouse any time — type a password, pass a CAPTCHA — then **hand control back** +- Browser sessions persist in the workspace, so the next task is already signed in -You can enter CDI device names one per line or separated with commas. Common GPU-related examples: - -- `nvidia.com/gpu=0` -- `nvidia.com/gpu=all` -- `amd.com/gpu=0` -- `amd.com/gpu=all` - -### Host Requirements - -Before configuring CDI devices in Memoh, the host machine must already provide working device drivers, vendor toolkit support where required, and valid CDI specs. In practice, this usually means: - -- the host GPU works normally outside the container -- CDI spec files exist under `/etc/cdi` or `/var/run/cdi` -- the device name you enter in Memoh matches a real CDI device on the host - -To discover the exact CDI device names exposed by the host, use the vendor tool on the host machine: - -- NVIDIA: `nvidia-ctk cdi list` -- AMD: `amd-ctk cdi list` - -If Memoh reports an error such as `unresolvable CDI devices`, the configured device name does not match any CDI device visible to the container runtime. - -### Important Behavior - -- CDI device settings are applied when the container is created. Updating the setting later requires recreating the container. -- Stopping and starting an existing container does not change its attached CDI devices. -- The container image still needs the appropriate user-space libraries and tools if you want to run CUDA or ROCm software inside the container. -- After creation, the **Workspace** tab shows the effective attached CDI devices for verification. +For the tool-level distinction, see [Browser / Computer Use](./browser-computer-use.md). ## Snapshots -Snapshots allow you to capture the current state of the bot's container workspace and restore it later. This is useful for saving a known good configuration, versioning the runtime, or testing complex changes safely. - -## Data Export and Import - -The **Workspace** tab supports exporting and importing workspace data for backup, migration, or sharing purposes. +**Create Snapshot** records the current workspace state — a rollback point before a big change; **Restore** reverts to a chosen snapshot, and unwanted snapshots can be deleted. -- **Export Data** packages the workspace filesystem data into a downloadable archive. -- **Import Data** extracts an uploaded archive into the workspace filesystem. -- **Restore** resets the data directory to a clean state when the filesystem has become corrupted or you want to start fresh without recreating the runtime. +## Import and export -## Versioning +- **Export Data**: package the workspace files for download. +- **Import Data**: upload an archive and unpack it into the workspace. +- **Reset**: return the data directory to a clean state — for when the filesystem is wrecked or you want a fresh start. -Memoh tracks workspace/container versions to manage the lifecycle of the bot runtime environment. Version information helps with auditing and understanding when runtime configuration changed. +::: tip Self-hosting +Which runtime the workspace runs on (containerd, Docker, Apple container, a trusted local directory) and how host devices such as GPUs are passed through are server-side deployment concerns — see [Workspace Backends](../self-hosted/workspace-backends.md). Memoh Cloud users never need to touch these. +::: diff --git a/docs/guides/extensions.md b/docs/guides/extensions.md index c62a537..fa08790 100644 --- a/docs/guides/extensions.md +++ b/docs/guides/extensions.md @@ -7,8 +7,8 @@ Memoh has five ways to extend what a bot can do. They sound alike until you put | [Skills](./skills.md) | `SKILL.md` prompt modules that change how the bot behaves | In the bot workspace under `/data/skills/`, managed on the **Skills** tab; invoked in conversation | Routines and working styles you would otherwise retype every time | | [Hooks](./hooks.md) | Event rules in `hooks.json` that run commands or tools | In `/data/.memoh/hooks.json`, edited on the **Hooks** tab; fires on lifecycle events such as `PreToolUse` or `TurnEnd` | Checks and side effects at fixed points, with no chat involved | | [MCP](./mcp.md) | Connections to external MCP tool servers | Configured per bot on the **MCP** tab, as a Stdio or Remote connection; discovered tools are used during conversation | Attaching a tool that already ships an MCP server | -| [Connectors](./connectors.md) | OAuth or API-key bindings to services such as GitHub or Notion | Connected from the Supermarket's **Connectors** tab, managed on the bot's **Connectors** tab; the service's tools appear in conversation | Letting the bot act on your account of a hosted service | -| [Supermarket](./supermarket.md) | Memoh's built-in catalog: one-click install of packaged apps — skills plus their dependencies and connectors | Under **Settings**; what you install lands in the target bot's own tabs | Getting a ready-made capability without assembling the parts | +| [Connectors](../self-hosted/connectors.md) | OAuth or API-key bindings to services such as GitHub or Notion | Arrive as components of an App; authorized and managed on the bot's **Apps** tab; the service's tools appear in conversation | Letting the bot act on your account of a hosted service | +| [Supermarket](./supermarket.md) | Memoh's built-in catalog: one-click install of packaged apps — skills plus their dependencies and connectors | Opened from the sidebar; what you install lands in the target bot's workspace and **Apps** tab | Getting a ready-made capability without assembling the parts | However the capability arrives, it converges in the same place: connector and MCP tools appear alongside the bot's workspace tools in conversation, and installed skills show up on the bot's **Skills** tab like hand-written ones. @@ -17,7 +17,7 @@ However the capability arrives, it converges in the same place: connector and MC - Change how the bot does its work → a [Skill](./skills.md). - Do something automatically at a fixed event → a [Hook](./hooks.md). - Attach a tool that has an MCP server → [MCP](./mcp.md). -- Let the bot use your GitHub or Notion account → a [Connector](./connectors.md). +- Let the bot use your GitHub or Notion account → a [Connector](../self-hosted/connectors.md). - Install a ready-made package in one click → [Supermarket](./supermarket.md). ::: tip They combine @@ -31,7 +31,7 @@ Each option has a full page with the details this table compresses: - [Skills](./skills.md) — writing `SKILL.md`, skill states, and adopting discovered skills. - [Hooks](./hooks.md) — the event catalog, the config schema, and testing a rule. - [MCP](./mcp.md) — Stdio and Remote connections, OAuth, and tool discovery. -- [Connectors](./connectors.md) — connection statuses, reauthorization, and tool namespaces. +- [Connectors](../self-hosted/connectors.md) — connection statuses, reauthorization, and tool namespaces. - [Supermarket](./supermarket.md) — browsing the catalog and installing to a bot. If you are unsure, browse the Supermarket first — an installed package shows what a finished setup looks like before you build your own. diff --git a/docs/guides/index.md b/docs/guides/index.md index 104ecdb..4f2a13d 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -9,7 +9,6 @@ Start here if you are new to Memoh. Learn how to install the app, create your fi - **[Overview](./overview.md)**: What Memoh is and how the pieces fit together. - **[Quick Start](./quick-start.md)**: Install the app, sign in, create your first bot, give it real work, and connect a chat platform. - **[Working with Bots](./working-with-bots.md)**: What to hand off, how to state a request, when to split bots — plus the full tab-by-tab configuration reference. -- **[Preferences](./preferences.md)**: Customize language, theme, typography, diagrams, and keyboard shortcuts. - **[Sessions](./sessions.md)**: Understand chat and discuss sessions, routing, and status panels. - **[Files](./files.md)**: Browse and edit files in a bot workspace. - **[Slash Commands](./slash-commands.md)**: Use command shortcuts for daily control. @@ -26,7 +25,7 @@ Deepen your usage once the basics are in place. These pages cover capabilities, - **[Workspace](./container.md)**: Understand workspace behavior from the product UI. - **[Browser / Computer Use](./browser-computer-use.md)**: Work with headed browsers and visible desktop sessions. - **[Skills](./skills.md)** and **[Supermarket](./supermarket.md)**: Add reusable prompt modules and catalog templates. -- **[Connectors](./connectors.md)**: Connect third-party services such as GitHub and Notion. +- **[Connectors](../self-hosted/connectors.md)**: Connect third-party services such as GitHub and Notion. - **[Hooks](./hooks.md)** and **[MCP](./mcp.md)**: Connect tools, automation rules, and external data sources. - **[Memory](./memory.md)**: Manage long-term memory after a provider is configured. - **[Compaction](./compaction.md)**: Reduce active session context size. @@ -35,7 +34,7 @@ Deepen your usage once the basics are in place. These pages cover capabilities, ## Use Cases -- **[Use Cases](./use-cases.md)**: Ready-to-follow scenarios that combine features to solve real problems. +- **[Use Cases](../use-cases/index.md)**: Ready-to-follow scenarios that combine features to solve real problems. ## Getting Help diff --git a/docs/guides/overview.md b/docs/guides/overview.md index 487a942..a5766cc 100644 --- a/docs/guides/overview.md +++ b/docs/guides/overview.md @@ -24,7 +24,7 @@ Pick something small you already do by hand every week, and state the outcome, s > Every Friday at 17:00, turn the links and files I sent you this week into a weekly report — grouped by theme, one line each. Save it in the workspace and post the summary to this conversation. Organize only what I sent you; never send anything to anyone else. -The bot registers the schedule itself and delivers weekly. Start with read-only work, review a few outputs, then widen what it may write and execute — see [Use Cases](./use-cases.md) for ready-made setups. +The bot registers the schedule itself and delivers weekly. Start with read-only work, review a few outputs, then widen what it may write and execute — see [Use Cases](../use-cases/index.md) for ready-made setups. ## FAQ @@ -51,7 +51,7 @@ The [Help Center](https://memoh.ai/help): plans, credits, account questions, and ## Next steps - [Quick Start](./quick-start.md) — from installing the app to a connected chat platform, in about fifteen minutes. -- [Use Cases](./use-cases.md) — ready-to-follow scenarios that combine features to solve real problems. +- [Use Cases](../use-cases/index.md) — ready-to-follow scenarios that combine features to solve real problems. - [Bot](./working-with-bots.md) — configure a bot tab by tab. - [Channels](../integrations/channels/index.md) — per-platform setup guides. - [Help Center](https://memoh.ai/help) — plans, billing, and account questions. diff --git a/docs/guides/preferences.md b/docs/guides/preferences.md deleted file mode 100644 index cc9c35e..0000000 --- a/docs/guides/preferences.md +++ /dev/null @@ -1,100 +0,0 @@ -# Preferences - -Memoh v0.13 includes user-level preferences for the client. These preferences change how the interface looks and how keyboard shortcuts behave for the current device profile. They do not change a bot's personality, model, tools, memory, or access rules. - -Open **Settings**, then use **Appearance** for visual preferences and **Keyboard** for shortcuts. - ---- - -## Appearance - -The **Appearance** page is split into interface, typography, code highlighting, and diagram settings. Changes apply immediately. - -### Interface - -| Setting | What It Does | -|---------|--------------| -| **Language** | Sets the interface language. v0.13 includes English, Simplified Chinese, and Japanese. If you have not chosen a language yet, Memoh detects English, Chinese, or Japanese from the browser language and falls back to English. | -| **Theme** | Chooses Light, Dark, or System. System follows the operating system or browser color mode. | -| **Color Scheme** | Changes the accent palette used by brand elements, status colors, and interface controls. Available schemes are Memoh, Ocean, Forest, Rose, and Amber. | - -Language is for the Memoh interface. A bot's reply language is still configured from the bot settings. - -### Typography - -Use typography settings when the interface feels too small, too large, or when you prefer a different code font. - -| Setting | What It Affects | Range / Default | -|---------|-----------------|-----------------| -| **UI Font Size** | General interface text and controls | `12`-`20` px, default `16` | -| **Code Font Size** | Code editors, Markdown code blocks, and terminal text | `11`-`20` px, default `13` | -| **UI Font Family** | The main interface font | Default: `system-ui, sans-serif` | -| **Code Font Family** | Code, editor, and terminal font stack | Default: `ui-monospace, monospace` | - -Font family fields accept normal CSS-style font stacks, such as `Inter, system-ui, sans-serif` or `"JetBrains Mono", ui-monospace, monospace`. The font must be available on your device or browser environment. Clear the field, or enter the default value, to return to Memoh's default stack. - -### Code Highlighting - -Memoh uses Shiki themes for highlighted code. You can choose separate themes for light mode and dark mode: - -| Setting | What It Affects | -|---------|-----------------| -| **Light theme** | Code blocks and editors while the interface is in light mode | -| **Dark theme** | Code blocks and editors while the interface is in dark mode | - -The theme picker searches the bundled Shiki theme list and shows a live preview, so you can compare the light and dark choices before leaving the page. - -### Diagrams - -Mermaid diagrams rendered in chat and Markdown previews use the **Mermaid Theme** preference. - -| Theme | Behavior | -|-------|----------| -| **Auto** | Matches the current interface mode. | -| **Default** | Uses Mermaid's default light theme. | -| **Dark** | Uses Mermaid's dark theme. | -| **Forest** | Uses Mermaid's forest theme. | -| **Neutral** | Uses Mermaid's neutral theme. | - -Diagrams that already include their own Mermaid initialization directive may keep their authored theme, which is useful for documents that need a specific diagram style. - ---- - -## Keyboard Shortcuts - -The **Keyboard** page lists editable shortcuts by scope. Click **Edit** on a row, press the new key combination, then save. - -### Default Shortcuts - -`Cmd` on macOS is shown as `Ctrl` on Windows and Linux. - -| Action | Default | Scope | -|--------|---------|-------| -| Close current workspace tab | `Cmd/Ctrl + W` in the desktop app. In a normal browser, the browser keeps its native close-tab behavior. | Global | -| Save active file | `Cmd/Ctrl + S` | Global | -| Toggle sidebar | `Cmd/Ctrl + B` | Global | -| Open Settings | `Cmd/Ctrl + K` | Global | -| Close media lightbox | `Esc` | Media Lightbox | -| Previous media | `Left Arrow` | Media Lightbox | -| Next media | `Right Arrow` | Media Lightbox | - -Global shortcuts are active across the app. Media Lightbox shortcuts are active only while the media preview overlay is open. - -### Editing Rules - -Memoh checks a shortcut before saving it: - -- `Cmd/Ctrl + W`, `Cmd/Ctrl + Q`, `Cmd/Ctrl + T`, and `Cmd/Ctrl + N` are reserved for the browser or operating system. -- Global shortcuts must include `Cmd/Ctrl` or `Alt`, so normal typing does not trigger app commands. -- Two shortcuts in the same scope cannot use the same combination. -- A shortcut may share a combination with a different scope, but Memoh shows a warning because only the active scope can use it. - -Use the reset button on a row to restore one shortcut. Use **Reset all** to clear every custom shortcut. - ---- - -## A Few Practical Notes - -- Appearance and keyboard preferences are personal UI preferences. Other users and bots are not changed. -- Preferences are stored on the current device/browser profile, so another browser or machine may need its own setup. -- If the interface looks wrong after experimenting with fonts or shortcuts, reset the changed field or shortcut from the same page. diff --git a/docs/guides/quick-start.md b/docs/guides/quick-start.md index cdd13da..29166fb 100644 --- a/docs/guides/quick-start.md +++ b/docs/guides/quick-start.md @@ -116,11 +116,11 @@ Once a routine is stable, stop retyping it: | Configure a bot tab by tab | [Bot](./working-with-bots.md) | | Understand chat, discuss, and routing | [Sessions](./sessions.md) | | Run scheduled or recurring tasks | [Schedule](./schedule.md) | -| Connect external tools and data | [MCP](./mcp.md), [Connectors](./connectors.md) | +| Connect external tools and data | [MCP](./mcp.md), [Connectors](../self-hosted/connectors.md) | | Install prebuilt capabilities | [Supermarket](./supermarket.md) | | Hook into lifecycle events | [Hooks](./hooks.md) | | Control who can talk to the bot | [Access Control](./access.md) | -| See what others run | [Use Cases](./use-cases.md) | +| See what others run | [Use Cases](../use-cases/index.md) | ::: tip Need help? Questions about plans, credits, or your account — or anything this site doesn't cover — are answered in the [Help Center](https://memoh.ai/help), where you can also reach the Memoh team. diff --git a/docs/guides/skills.md b/docs/guides/skills.md index 17db57e..39ff836 100644 --- a/docs/guides/skills.md +++ b/docs/guides/skills.md @@ -1,16 +1,14 @@ -# Bot Skills +# Skills -Skills are reusable prompt modules that extend a bot's behavior, style, and tool-usage guidance. You manage them from the bot's **Skills** tab, and you can either write them yourself or install them from **[Supermarket](./supermarket.md)**. +A **Skill** is a reusable prompt module that teaches a bot a fixed way of working: tone, procedure, tool habits. Skills have no dedicated management screen — a skill is a file in the workspace, and putting it in the right directory is all it takes to load. ::: tip Limits -A conversation can request at most 5 skills at once; each skill injects up to 64 KiB, with a 256 KiB total cap. These caps are fixed. +A session can request at most 5 skills at once; a single skill injects up to 64 KiB, 256 KiB total. These caps are not configurable. ::: ---- - -## What A Skill Looks Like +## What one looks like -A skill is a Markdown file named `SKILL.md` with YAML frontmatter. At minimum, give it a stable `name` and a short `description`. +A skill is a directory containing a `SKILL.md` with a YAML header — at minimum a stable `name` and a short `description`. The body is the instruction text actually injected for the agent: ```yaml --- @@ -20,142 +18,36 @@ description: Enables advanced coding workflows and tool usage. # Coder Skill -You write clear code, explain trade-offs, and use file or command tools when they help complete the task. +Write clear code, explain trade-offs, and use the file/command tools when the task calls for them. ``` -Practical rules: - -- Use a simple ASCII skill name such as `coder-skill`, `research`, or `docs-helper`. -- Avoid spaces in the `name`; Memoh uses it as the skill directory name. -- The Markdown body is the actual instruction content injected into the bot runtime. - ---- - -## Where Skills Come From - -Memoh distinguishes between **managed** skills and **discovered** skills: - -- **Managed** skills are the ones you create, edit, or install through Memoh. They live under `/data/skills//SKILL.md`. -- **Discovered** skills are found from compatibility locations inside the bot environment, such as legacy skill directories from imported images or older setups. - -Memoh scans these container-internal roots in order: - -| Type | Root | -|------|------| -| Managed | `/data/skills/` | -| Legacy discovered | `/data/.skills/` | -| Compatibility discovered | `/data/.agents/skills/` | -| Compatibility discovered | `/root/.agents/skills/` | - -Within each root, Memoh looks for `SKILL.md` either directly under the root or inside a named subdirectory such as `/data/skills/coder-skill/SKILL.md`. - -This matters because the same skill name can appear from multiple sources. Memoh resolves those duplicates into states. - ---- - -## Skill States - -Each listed skill source has one of these states: - -| State | Meaning | -|-------|---------| -| `effective` | This is the version currently active for that skill name | -| `shadowed` | Another source with the same skill name takes precedence | -| `disabled` | This specific source has been disabled and will not be used | - -The important mental model is: **the skill name is the identity**. If Memoh finds multiple `coder-skill` sources, only one can be `effective`. - -### Typical Examples - -- A skill you just created in Memoh is usually `managed` + `effective`. -- A legacy skill can show up as `effective` until you create or adopt a managed skill with the same name. -- After you adopt a discovered skill into the managed directory, the managed copy becomes `effective` and the old source usually becomes `shadowed`. -- If you disable the effective source, another source with the same name may become `effective` automatically. - ---- - -## Managing Skills In The UI - -Open a bot, then go to **Skills**. - -### Add Skill - -1. Click **Add Skill**. -2. Fill in the raw Markdown in the editor. -3. Save it. +Use plain ASCII names (`coder-skill`, `research`) without spaces — the name doubles as the directory name. -Memoh writes the file into its managed skills directory. +## Which directory to use -### Edit Skill +Put skills you write yourself in this directory of the bot's workspace: -- Use **Edit** on a card to update the raw `SKILL.md` content. -- Editing is most useful for managed skills you own directly in Memoh. - -### Delete Skill - -- **Delete** removes the managed skill directory for that skill name. -- Deleting a managed skill can expose a discovered fallback source with the same name, making that fallback become `effective`. - -### Disable / Enable - -- **Disable** turns off one specific skill source without deleting it. -- **Enable** re-enables a previously disabled source. - -Use this when you want to test a fallback or temporarily remove a skill from the prompt without losing its content. - -### Adopt - -**Adopt** copies a discovered skill into Memoh's managed skills directory so you can own and edit it from the UI. - -Use adopt when: - -- a skill came from a legacy or compatibility source -- you want that skill to become part of your Memoh-managed configuration -- you want to edit it safely in the UI later - -Adopt is not available once a managed skill with the same name already exists. - ---- - -## Effective Skills At Runtime - -Only **effective** skills are loaded into the bot runtime. - -That means: - -- `shadowed` skills are visible for inspection, but not used -- `disabled` skills are ignored -- the active prompt only sees the current effective set - -In active sessions, the **Session Status Panel** can also show which skills were used during that session. - ---- - -## Built-in Skills From The Workspace Template - -Memoh ships a couple of built-in skills (such as `skill-creator` and `hooks-setup`) as part of the workspace template. These are **kept in sync automatically**: every time the workspace is bootstrapped or reconciled, the built-in copies are refreshed to the current template version. - -Practical consequences: - -- **Do not edit a built-in skill in place** — your edits will be overwritten on the next refresh. To customize one, copy it into a skill under a different name (or adopt it into a managed skill) instead. -- Your own skills placed alongside them are never removed by the sync. -- Template-provided workspace files like `AGENTS.md` are different: they are created only when missing, so your edits to those are preserved. +```text +/data/skills/user/personal//SKILL.md +``` -## Supermarket And Imported Skills +Any way of getting the file there works: create it on the bot's **Files** tab, use the **Terminal**, or simply ask the bot — the workspace ships with a `skill-creator` skill, so describe the procedure you want and it writes the files to the right place. -Two common ways skills appear without being typed manually: +You will see other directories, but **don't put files there by hand**: -- **Supermarket install**: Memoh downloads the selected skill into the managed skills directory, so it behaves like a normal managed skill. -- **Imported / legacy environment**: Memoh discovers existing skills from compatibility paths and shows them as discovered sources. +| Directory | Owned by | +|-----------|----------| +| `/data/skills/user/personal/` | **You.** All hand-written skills go here | +| `/data/skills///` | [Apps](./supermarket.md). Installed, updated, and removed with the App — don't edit | +| `/data/.memoh/skills/` | Built-in skills from the workspace template (such as `skill-creator`). Refreshed to the template version on every workspace init, so edits get overwritten; to customize, copy it under a new name into your own directory | +| `/data/.skills/`, `/data/.agents/skills/` | Legacy compatibility paths, discovery only — don't add new files | -If a discovered skill is useful but you want to fully manage it in Memoh, adopt it. +## Same name, multiple copies ---- +**The skill name is its identity**: however many directories a name appears in, only one copy is effective at a time. A skill in your own directory takes precedence over one in a legacy path. To change how an App's skill behaves, don't edit its files — write your own version under a new name. -## Recommended Workflow +## Recommendations -1. Start with a small number of focused skills. -2. Prefer clear names and short descriptions. -3. Use **Disable** before **Delete** if you are unsure. -4. Use **Adopt** for legacy skills you plan to keep. -5. Install reusable skills from **[Supermarket](./supermarket.md)** instead of copy-pasting them repeatedly. +1. Keep them few and sharp, with a clear `name` and `description` — the agent decides whether to load a skill from its description. +2. Only recurring procedures are worth turning into skills; one-off requirements can just be said in chat. +3. Prefer installing from the [Supermarket](./supermarket.md) over copy-pasting duplicates. diff --git a/docs/guides/supermarket.md b/docs/guides/supermarket.md index 241b956..724036c 100644 --- a/docs/guides/supermarket.md +++ b/docs/guides/supermarket.md @@ -1,50 +1,44 @@ # Supermarket -Supermarket is Memoh's built-in catalog for **connectors** and **skills**. Connectors bind third-party services such as GitHub or Notion to a bot; skills are reusable procedures the agent can load on demand. +The Supermarket is Memoh's built-in App catalog. An **App** here is a packaged unit of capability: one App can carry several **Skills** (reusable procedures), **dependencies** (tools installed into the workspace), and **connectors** (bindings to third-party services such as GitHub or Notion). You install the App as a whole — no separate hunting for Skills or connectors. -The app shows Supermarket under **Settings** with two tabs: - -- **Connectors** -- **Skills** - -**Connectors** comes first and is the default landing tab when the server has [Connect-It configured](./connectors.md#requirements). Without Connect-It, the tab is hidden and **Skills** is the default instead. +Open **Supermarket** from the client sidebar: Apps are laid out by category, searchable, and filterable by tag. An App's detail page shows its description, component makeup (how many Skills, dependencies, and connectors), author, version, source registry, and links. --- -## Connect A Service +## Install an App -The **Connectors** tab lists services a bot can connect through OAuth or an API key. Pick one, click **Connect**, select the target bot, and complete the authorization. The full flow — authentication methods, connection statuses, and how connector tools reach the bot — is documented in [Connectors](./connectors.md). +1. Pick an App in the **Supermarket** and open its detail page. +2. Click **Install to Bot** and choose the target bot. +3. If the App declares environment variables, fill in the required values first. +4. Confirm the installation. ---- +Installing and updating needs the bot's workspace running: Skills are written into the workspace, dependencies are installed into it, and connectors are bound. Installation shows progress; an interrupted install can be **resumed** or **restored**. -## Install A Skill +--- -1. Open **Supermarket** in the app. -2. Switch to the **Skills** tab. -3. Choose a skill and click **Install**, or open the skill detail page and click **Install to Bot**. -4. Select the target bot. -5. Confirm the install. -6. The skill appears in that bot's **Skills** tab. +## After installing: the bot's Apps tab -Skills install into the bot's managed skills directory (`/data/skills/` inside the bot workspace). Skill detail pages show the author, version, registry, and links. See [Skills](./skills.md) for how skills are loaded and used. +The **Apps** tab on the bot detail page lists installed Apps with per-component status: ---- +| Component | Where it goes | +|-----------|---------------| +| **Skills** | Written to the managed workspace directory `/data/skills///`, owned by the App — updated and removed with it, so don't edit them by hand (see [Skills](./skills.md)) | +| **Dependencies** | Installed into the bot's workspace and shared with other Apps in the same workspace that need them | +| **Connectors** | Marked **Needs authorization**, **Optional**, or **Shared across workspaces**; click **Authorize** to run OAuth or enter an API key (see [Connectors](../self-hosted/connectors.md)) | -## Configure Supermarket +Common actions: **Check for updates**, **Update**, **Remove**. When some components failed or still need authorization, the App is flagged as needing attention — open its component list to finish setup. -By default, Memoh reads Supermarket content from: +--- -```toml -[supermarket] -base_url = "https://supermarket.memoh.ai" -``` +## Where the catalog comes from -Operators can point `supermarket.base_url` at another trusted catalog. The configured endpoint is used for the connector list, skill lists, skill details, and skill downloads. The **Registry** filter in the Skills tab lets you narrow results to a single upstream registry. +Supermarket content is served from an upstream registry, `supermarket.memoh.ai` by default. Self-hosted instances can point `supermarket.base_url` at another trusted catalog; see the configuration reference in [Server Deploy](../self-hosted/docker.md). --- -## Contribute +## Contributing -Contribute new skills here: +New Apps can be submitted to: - [felinics/supermarket](https://github.com/felinics/supermarket) diff --git a/docs/guides/use-cases.md b/docs/guides/use-cases.md index cbbfa32..4223359 100644 --- a/docs/guides/use-cases.md +++ b/docs/guides/use-cases.md @@ -1,101 +1,16 @@ -# Use Cases - -Ready-to-follow scenarios that combine multiple Memoh features to solve real problems. - -A good bot **owns a repeatable outcome**, not a loose category of questions. Each scenario below states what the bot owns, which features it uses, and a starting prompt you can send as-is. Every example starts with read-only work — check the output first, then grant more. - -## Morning Digest - -**Owns:** one message that starts your workday with everything you care about. - -**Uses:** [Scheduled Tasks](./schedule.md) · [Web Search Providers](../integrations/providers/web-search.md) · [Platforms](../integrations/channels/index.md) - -**Start with:** - -> Every weekday at 8am, summarize releases and notable issues from the repositories I follow over the last 24 hours, add today's weather, and send it to me as one digest. Cite a source for every item; if something is uncertain, say so instead of guessing. - -The bot has a `schedule` tool: describe the timing in plain language and it registers the cron entry itself. Cap the first runs with **Max Calls** until the format looks right. - -## Release Watch - -**Owns:** an external change you are waiting for, reported the moment it happens. - -**Uses:** [Scheduled Tasks](./schedule.md) · [Workspace](./container.md) · [Platforms](../integrations/channels/index.md) - -**Start with:** - -> Watch this project's releases page and check every 30 minutes. When a new version ships, write the changes up as Markdown in your workspace and ping me once on Telegram. Organize only — do not run any upgrade or install anything. - -"It's there even when you're not" is schedules plus proactive messages: check on a timer, speak only when something changed. The same pattern watches prices, stock, or document updates. - -## Group On-Call Assistant - -**Owns:** secretary duty in a team group: answers when mentioned and posts a daily recap. - -**Uses:** [Platforms](../integrations/channels/index.md) · [Sessions](./sessions.md) · [Access Control](./access.md) · [Scheduled Tasks](./schedule.md) - -**Start with:** - -> Once you join this group: when someone mentions you, summarize the day's discussion and open items. Every day at 6pm, post a recap organized as decisions / to-dos / open questions. Post only in this group — never message anyone privately. - -Use the "group only" [Access Control](./access.md) preset to fence its territory. In discuss sessions the bot decides for itself whether it has anything worth saying, so it will not flood the channel. - -## A Living Spreadsheet - -**Owns:** one data file that the bot creates, updates on schedule, and reports changes to first. - -**Uses:** [Workspace](./container.md) · [Files](./files.md) · [Scheduled Tasks](./schedule.md) - -**Start with:** - -> Create a competitor pricing sheet (CSV) in your workspace. Check each vendor's site every morning and append any changes to the sheet; message me first if a price drops. Maintain this file only — do not send anything to anyone else. - -The workspace is a real filesystem with a terminal (Python, Node.js, and uv preinstalled), so cleaning CSVs, running scripts, and generating reports all happen in place. Browse the output any time under **Files**. - -## Screen Work Behind Logins - -**Owns:** web tasks that need eyes on a screen: console checks, form flows, OAuth. - -**Uses:** [Browser / Computer Use](./browser-computer-use.md) · [Workspace](./container.md) (visible desktop) - -**Start with:** - -> Open our admin console and verify the configuration against the checklist I give you, saving a screenshot of each item into the workspace. If you hit a login, a CAPTCHA, or anything you are unsure about, stop and wait for me to take over the desktop; continue after I hand it back. Read-only throughout — change no settings. - -The visible desktop works both ways: watch it work in the desktop pane, or take over the keyboard to type a password, then hand control back. The browser session stays in the workspace, so the next task is already signed in. - -## Build and Preview in the Cloud - -**Owns:** a small project built in its own workspace, running where you can see it. - -**Uses:** [Agents / ACP](./acp.md) · [Workspace](./container.md) · [Skills](./skills.md) - -**Start with:** - -> Build a reading-list web page in your workspace: add items, mark them finished, filter by theme. When it works, start the dev server and tell me how to preview it. Commit every change locally with git — do not push to any remote. - -Prefer Claude Code or Codex? Attach your own subscription on the bot's **Agent** tab; it keeps working in the same workspace, on the same files. - -## An Assistant That Remembers - -**Owns:** your preferences and project state, carried across sessions and platforms. - -**Uses:** [Memory](./memory.md) · [Platforms](../integrations/channels/index.md) · [Scheduled Tasks](./schedule.md) - -**Start with:** - -> Remember these preferences: mornings are for deep work, meetings go in the afternoon, and the weekly report is due Friday before end of day. From now on, check memory before scheduling reminders or writing summaries; if a preference is unclear, ask me instead of guessing. +--- +layout: false +title: Redirecting +--- -With a [memory provider](../integrations/providers/memory/builtin.md) configured, "whatever happened with that PR?" is a question it can just answer. When memories pile up, run **Compact** to merge and dedupe. + -## From Example to Routine + -1. **Start read-only.** Let it read and prepare; review a few outputs before granting writes or execution. -2. **Put constraints in the instructions.** Outcome, sources, constraints, format, checkpoints — spell out all five (see [Quick Start](./quick-start.md)). -3. **Save repeated flows as [Skills](./skills.md).** One sentence should invoke the whole routine. -4. **Add a [Schedule](./schedule.md) only once the flow is stable.** Trial-run with Max Calls first. -5. **Keep writes and external actions behind approval,** even after the routine feels safe. -6. **Fence who can command it with [Access Control](./access.md)** — especially bots that join group chats. -7. **Let [Memory](./memory.md) hold your preferences.** A correction made once should stick. +Redirecting to [/use-cases/](/use-cases/). diff --git a/docs/guides/working-with-bots.md b/docs/guides/working-with-bots.md index 1ac825a..53cf78d 100644 --- a/docs/guides/working-with-bots.md +++ b/docs/guides/working-with-bots.md @@ -10,7 +10,7 @@ A task is a good fit for a bot when three things hold: - **Reachable sources.** The files, sites, or conversations involved are ones the bot can actually get to: uploaded into its workspace, connected as a channel or service, or public. - **A checkable result.** You can tell at a glance whether the output is right, so reviewing stays cheap. -When all three hold, start read-only anyway: let the bot read and organize first, review a few outputs, then grant more. Every scenario in [Use Cases](./use-cases.md) begins this way. +When all three hold, start read-only anyway: let the bot read and organize first, review a few outputs, then grant more. Every scenario in [Use Cases](../use-cases/index.md) begins this way. ## State the request @@ -67,7 +67,7 @@ In practice: 2. Review the first few runs before widening anything. 3. Keep actions that leave the workspace — messages to other people, anything external — behind approval even after the routine feels safe. -This is the same path the [Use Cases](./use-cases.md#from-example-to-routine) checklist walks: approving a few requests costs far less than undoing a wrong write. +This is the same path the [Use Cases](../use-cases/index.md#from-example-to-routine) checklist walks: approving a few requests costs far less than undoing a wrong write. --- @@ -128,7 +128,6 @@ If you have not created these resources yet, set them up first: - [Providers And Models](../integrations/providers/llm.md) - [Built-in Memory Provider](../integrations/providers/memory/builtin.md) - [Search Providers](../integrations/providers/web-search.md) -- [TTS: Edge](../integrations/providers/tts/edge.md) - [Agents / ACP](./acp.md) --- @@ -152,7 +151,7 @@ The **General** tab contains the settings that shape everyday conversation behav Notes: - The **Image Generation Model** is intentionally separate from the normal chat model so you can dedicate an image-capable model only to visual generation tasks. -- The **TTS Model** comes from the [TTS provider](../integrations/providers/tts/edge.md) flow and uses `speech` models from the configured speech provider. +- The **TTS Model** comes from the **Speech** settings page and uses `speech` models from the configured speech provider. - The selected chat model's `context_window` influences session status reporting and [Context Compaction](./compaction.md). --- diff --git a/docs/integrations/index.md b/docs/integrations/index.md index 442a57f..33619c1 100644 --- a/docs/integrations/index.md +++ b/docs/integrations/index.md @@ -15,7 +15,6 @@ Providers connect Memoh to external capability backends. - **[LLM Providers](/integrations/providers/llm)**: Configure upstream APIs, client types, and model roles. - **[Memory Providers](/integrations/providers/memory/builtin)**: Choose built-in memory, Mem0, or OpenViking. -- **[TTS Providers](/integrations/providers/tts/edge)**: Configure speech synthesis providers and models. - **[Web Search Providers](/integrations/providers/web-search)**: Configure search provider access. ## Product Guides diff --git a/docs/integrations/providers/llm.md b/docs/integrations/providers/llm.md index 488760d..948d77a 100644 --- a/docs/integrations/providers/llm.md +++ b/docs/integrations/providers/llm.md @@ -7,7 +7,7 @@ To use Memoh effectively, you usually configure: - optional **speech providers** if you want text-to-speech - optional **transcription providers** if you want speech-to-text -Chat and embedding providers/models are managed from the **Models** page in the app. Speech models are managed from [TTS Providers](./tts/edge.md), and transcription models are managed from the Transcription settings page. +Chat and embedding providers/models are managed from the **Models** page in the app. Speech models are managed from the **Speech** settings page, and transcription models are managed from the Transcription settings page. --- @@ -70,7 +70,7 @@ Memoh currently supports these client types: | `microsoft-speech` | Microsoft speech providers | | `google-transcription` | Google transcription providers | -Speech and transcription client types are for audio workflows, not for chat. Configure speech through [TTS Providers](./tts/edge.md) and transcription through the Transcription settings page. Exact model and voice availability depends on the configured provider template and upstream account. +Speech and transcription client types are for audio workflows, not for chat. Configure speech through the **Speech** settings page and transcription through the Transcription settings page. Exact model and voice availability depends on the configured provider template and upstream account. --- @@ -151,7 +151,7 @@ Memoh distinguishes four model types: Important distinction: - The **Models** page is primarily where you manage `chat` and `embedding` models. -- `speech` models are exposed through [TTS Providers](./tts/edge.md). +- `speech` models are exposed through the **Speech** settings page. - `transcription` models are exposed through the Transcription settings page. --- @@ -216,7 +216,7 @@ Use embedding models with memory providers or any feature that relies on vector ## Speech And Transcription Models -Speech models are managed from [TTS Providers](./tts/edge.md), not from the standard chat provider flow. +Speech models are managed from the **Speech** settings page, not from the standard chat provider flow. Current speech provider categories include: @@ -257,5 +257,5 @@ You do not need to force one model to do everything. ## Next Steps - To assign chat, image, memory, and TTS settings to a bot, see [Bot Management](../../guides/working-with-bots.md). -- To configure speech providers and speech models, see [TTS Providers](./tts/edge.md). +- To configure speech providers and speech models, see the **Speech** settings page. - To configure speech-to-text, open the Transcription settings page in the app. diff --git a/docs/integrations/providers/memory/mem0.md b/docs/integrations/providers/memory/mem0.md deleted file mode 100644 index 20afa43..0000000 --- a/docs/integrations/providers/memory/mem0.md +++ /dev/null @@ -1,45 +0,0 @@ -# Mem0 Memory Provider - -Mem0 is a SaaS memory provider that connects your bot to the [Mem0](https://mem0.ai) platform. Instead of managing memory infrastructure yourself, Mem0 handles storage, retrieval, and indexing through its cloud API. - ---- - -## Creating a Mem0 Provider - -1. Navigate to the **Memory Providers** page. -2. Click **Add Memory Provider**. -3. Fill in the following fields: - - **Name**: A display name for this provider. - - **Provider Type**: Select `mem0`. -4. Click **Create**. - ---- - -## Configuring a Mem0 Provider - -After creating a provider, select it from the list and configure its settings. - -| Field | Required | Description | -|-------|----------|-------------| -| **Base URL** | No | Mem0 API base URL. Defaults to `https://api.mem0.ai` when empty. | -| **API Key** | Yes | API key for Mem0 authentication (stored as a secret). | -| **Organization ID** | No | Organization ID for workspace scoping. | -| **Project ID** | No | Project ID for workspace scoping. | - ---- - -## Assigning a Mem0 Provider to a Bot - -1. Navigate to the **Bots** page and open your bot. -2. Go to the **General** tab. -3. Find the **Memory Provider** dropdown. -4. Select the Mem0 provider you created. -5. Click **Save**. - ---- - -## Usage - -Once assigned, the bot will use Mem0 as its memory backend. Memory extraction, search, and management operations are routed through the Mem0 API. - -For day-to-day memory operations, see [Bot Memory Management](../../../guides/memory.md). diff --git a/docs/integrations/providers/memory/openviking.md b/docs/integrations/providers/memory/openviking.md deleted file mode 100644 index a9b4dc4..0000000 --- a/docs/integrations/providers/memory/openviking.md +++ /dev/null @@ -1,43 +0,0 @@ -# OpenViking Memory Provider - -OpenViking is a memory provider that can be self-hosted or used as a SaaS service. It provides an alternative memory backend for bots that need a dedicated memory API. - ---- - -## Creating an OpenViking Provider - -1. Navigate to the **Memory Providers** page. -2. Click **Add Memory Provider**. -3. Fill in the following fields: - - **Name**: A display name for this provider. - - **Provider Type**: Select `openviking`. -4. Click **Create**. - ---- - -## Configuring an OpenViking Provider - -After creating a provider, select it from the list and configure its settings. - -| Field | Required | Description | -|-------|----------|-------------| -| **Base URL** | Yes | OpenViking API endpoint (e.g. `http://openviking:8088`). | -| **API Key** | No | API key for authentication (stored as a secret). | - ---- - -## Assigning an OpenViking Provider to a Bot - -1. Navigate to the **Bots** page and open your bot. -2. Go to the **General** tab. -3. Find the **Memory Provider** dropdown. -4. Select the OpenViking provider you created. -5. Click **Save**. - ---- - -## Usage - -Once assigned, the bot will use OpenViking as its memory backend. Memory extraction, search, and management operations are routed through the OpenViking API. - -For day-to-day memory operations, see [Bot Memory Management](../../../guides/memory.md). diff --git a/docs/integrations/providers/tts/edge.md b/docs/integrations/providers/tts/edge.md deleted file mode 100644 index a648837..0000000 --- a/docs/integrations/providers/tts/edge.md +++ /dev/null @@ -1,44 +0,0 @@ -# Edge TTS - -Edge TTS uses Microsoft Edge's public read-aloud API for speech synthesis. It is free, requires no API key, and supports 256+ voices across 50+ languages. - ---- - -## Creating an Edge TTS Provider - -1. Navigate to the **TTS Providers** page. -2. Click **Add**. -3. Select `edge` as the provider type. -4. Click **Create**. - -The default model `edge-read-aloud` is automatically imported when the provider is created. - ---- - -## Configuring the Model - -Click the `edge-read-aloud` model to configure its settings. - -| Field | Description | -|-------|-------------| -| **Voice** | Language + voice ID. Default: `en-US-EmmaMultilingualNeural`. Over 256 voices available across 50+ languages. | -| **Format** | Audio output format. Options: `audio-24khz-48kbitrate-mono-mp3` (default), `audio-24khz-96kbitrate-mono-mp3`, `webm-24khz-16bit-mono-opus`. | -| **Speed** | Playback speed. Options: `0.5`, `1.0` (default), `2.0`, `3.0`. | -| **Pitch** | Voice pitch adjustment. Range: `-100` to `+100`, default `0`. | - ---- - -## Assigning to a Bot - -1. Open a bot's **General** tab. -2. Find the **TTS Model** dropdown. -3. Select the configured Edge TTS model. -4. Click **Save**. - -The bot can now synthesize speech using Edge TTS. - ---- - -## Testing - -Use the built-in synthesis test button on the model configuration page to preview how the selected voice, format, speed, and pitch sound before assigning to a bot. diff --git a/docs/memory-providers/mem0.md b/docs/memory-providers/mem0.md deleted file mode 100644 index 45656f3..0000000 --- a/docs/memory-providers/mem0.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: false -title: Redirecting ---- - - - - - -Redirecting to [/integrations/providers/memory/mem0](/integrations/providers/memory/mem0). diff --git a/docs/memory-providers/openviking.md b/docs/memory-providers/openviking.md deleted file mode 100644 index 200d408..0000000 --- a/docs/memory-providers/openviking.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: false -title: Redirecting ---- - - - - - -Redirecting to [/integrations/providers/memory/openviking](/integrations/providers/memory/openviking). diff --git a/docs/self-hosted/connectors.md b/docs/self-hosted/connectors.md new file mode 100644 index 0000000..e153e42 --- /dev/null +++ b/docs/self-hosted/connectors.md @@ -0,0 +1,56 @@ +# Connectors (Connect-It) + +Connectors let bots use tools from third-party services such as GitHub and Notion. They are backed by [Connect-It](https://github.com/memohai/connect-it), a companion service deployed alongside Memoh. All credentials (OAuth tokens, API keys) live on the Connect-It side; Memoh only keeps a binding table — which bot is bound to which connection, what the tool namespace is called, and whether it is enabled. + +From a user's point of view, connectors are not installed on their own: they arrive as components of an [App](../guides/supermarket.md). An App's manifest declares which connector types it uses and whether each is required; after installing, you authorize them on the bot's **Apps** tab. The rest of this page is the operator view — how to run Connect-It and how connections work underneath. + +--- + +## Server requirements + +The connector feature only appears when the server has a Connect-It endpoint configured: + +```toml +[connect_it] +base_url = "" # e.g. "http://connect-it:8421" +api_token = "" # trusted server-to-server token +``` + +Leaving both empty disables the feature. In production, prefer the corresponding environment variables (`MEMOH_CONNECT_IT_BASE_URL`, `MEMOH_CONNECT_IT_API_TOKEN`). + +The one-line Server Deploy brings up a co-hosted Connect-It on fresh installs; see [Server Deploy](./docker.md#connect-it-connectors). Without Connect-It configured, App components that depend on a connector show as unavailable. + +--- + +## Authorization and management + +After installing an App that carries connectors, the bot's **Apps** tab lists them among the App's components, marked **Needs authorization**, **Optional**, or **Shared across workspaces**. Click **Authorize** to complete the binding — OAuth runs through a popup (allow popups for the page if the browser blocks it); API-key connectors ask for the credential fields instead. + +Each connection shows a status: + +| Status | Meaning | +|--------|---------| +| **Connected** | Healthy; tools are available to the bot | +| **Waiting for authorization** | The connection exists but OAuth never finished; complete it or disconnect | +| **Authorization required** | Credentials expired or were revoked; click **Reauthorize** | +| **Authorization failed** | The last authorization attempt failed; **Reauthorize** retries it | +| **Unavailable** | The configured Connect-It does not provide this connector type | +| **Disabled** | Turned off; tools are not given to the bot | + +You can **enable / disable** a connection without deleting it. **Disconnect** removes the binding from the bot **and** deletes the stored connection (credentials included) on the Connect-It side — Apps that used it will need to be reauthorized. + +--- + +## How tools reach the bot + +During conversation, Memoh aggregates all of a bot's enabled, healthy connections into one MCP session and hands it to the agent as a tool source. Connector tools appear alongside workspace and MCP tools. + +Each connection receives a **tool namespace** generated from its connector type at binding time — a GitHub connection is `github`, a second one becomes `github-2`. The namespace stays fixed for the lifetime of the binding: adding or removing other connections later never changes the tool names of existing ones. + +--- + +## Related pages + +- [Supermarket](../guides/supermarket.md) — where Apps (connector components included) are installed from. +- [MCP](../guides/mcp.md) — manage MCP connections directly. +- [Server Deploy](./docker.md#connect-it-connectors) — co-hosting Connect-It, credential management, and OAuth callback URLs. diff --git a/docs/self-hosted/docker.md b/docs/self-hosted/docker.md index a724fd4..11eb885 100644 --- a/docs/self-hosted/docker.md +++ b/docs/self-hosted/docker.md @@ -21,12 +21,12 @@ The Docker Compose stack consists of multiple services. Some are always started, | **pgvector** | *(core)* | PostgreSQL with `pgvector` used for optional memory embeddings; see [Built-in Memory](../integrations/providers/memory/builtin.md) | | **migrate** | *(core, one-shot)* | Runs `memoh-server migrate up` before the server starts | | **webhook-tunnel** | `webhook-tunnel` | Optional `cloudflared` quick tunnel that exposes the channel worker's webhook listener to the internet | -| **connect-it** | `connectors` | Co-hosted [Connect-It](https://github.com/memohai/connect-it) service backing bot [connectors](../guides/connectors.md) (see below) | +| **connect-it** | `connectors` | Co-hosted [Connect-It](https://github.com/memohai/connect-it) service backing bot [connectors](./connectors.md) (see below) | ### Connect-It Connectors -The **connect-it** container runs [Connect-It](https://github.com/memohai/connect-it), the service behind bot [connectors](../guides/connectors.md) — it links third-party services such as GitHub and Notion to bots via OAuth or API keys. It shares Memoh's PostgreSQL instance with its data isolated in a separate `connect_it` schema, and manages its own migrations. +The **connect-it** container runs [Connect-It](https://github.com/memohai/connect-it), the service behind bot [connectors](./connectors.md) — it links third-party services such as GitHub and Notion to bots via OAuth or API keys. It shares Memoh's PostgreSQL instance with its data isolated in a separate `connect_it` schema, and manages its own migrations. The install script manages Connect-It end to end: @@ -170,7 +170,7 @@ Add `--profile connectors` for co-hosted Connect-It and `--profile webhook-tunne > **Important**: `docker-compose.yml` mounts `./config.toml` by default. You must create this file before starting — running without it will fail. -To enable [connectors](../guides/connectors.md) in a manual deployment, generate the Connect-It credentials yourself and add the `connectors` profile: +To enable [connectors](./connectors.md) in a manual deployment, generate the Connect-It credentials yourself and add the `connectors` profile: ```bash MEMOH_CONNECT_IT_BASE_URL="http://connect-it:8421" \ @@ -237,7 +237,7 @@ The `config.toml` file controls all server behavior. Here is a summary of the av | `[internal_rpc]` | Server/channel-worker RPC targets and shared secret for the split deployment | | `[webhook_tunnel]` | Webhook tunnel mode (`disabled` or `external`) and `public_base_url` | | `[registry]` | Provider definitions directory | -| `[connect_it]` | Connect-It endpoint for [connectors](../guides/connectors.md) (`base_url`, `api_token`); both empty disables the feature. The Compose environment overrides these via `MEMOH_CONNECT_IT_BASE_URL` / `MEMOH_CONNECT_IT_API_TOKEN`. | +| `[connect_it]` | Connect-It endpoint for [connectors](./connectors.md) (`base_url`, `api_token`); both empty disables the feature. The Compose environment overrides these via `MEMOH_CONNECT_IT_BASE_URL` / `MEMOH_CONNECT_IT_API_TOKEN`. | | `[web]` | Web frontend host and port | | `[agent]` | Tool output truncation limits: `tool_output_max_bytes` (default 65536), `tool_output_max_lines` (default 2000), `system_files_max_bytes` (default 32768). Oversized tool output keeps head and tail instead of being cut off blindly. | | `[session_runtime]` | Session-state backend for multi-instance deployments; see [Multi-Instance Deployments](#multi-instance-deployments) | diff --git a/docs/self-hosted/workspace-backends.md b/docs/self-hosted/workspace-backends.md index 5a634a0..48bbd11 100644 --- a/docs/self-hosted/workspace-backends.md +++ b/docs/self-hosted/workspace-backends.md @@ -109,3 +109,31 @@ Runtime capabilities differ by backend: | `local` | Host network | No | Host-level only | No container desktop | Overlay provider settings are configured per bot in the app, not in the global TOML file. The global backend still matters because it decides which overlay driver can run. + +## CDI devices (GPU passthrough) + +To pass host devices into a containerized workspace through **CDI** (GPUs being the common case), configure it under the bot's **Workspace** → **Advanced**. Only bother when you actually need CUDA/ROCm workloads inside the workspace. + +### Setup + +1. Open the **Workspace** tab; **Create** the container first if there is none. +2. Expand **Advanced**, enable **GPU**, and list device names under **CDI devices**, one per line or comma-separated: + - `nvidia.com/gpu=0`, `nvidia.com/gpu=all` + - `amd.com/gpu=0`, `amd.com/gpu=all` + +### Host requirements + +Drivers, vendor tooling, and CDI specs must already be in place on the host. That usually means: + +- The GPU already works on the host itself +- Specs exist under `/etc/cdi` or `/var/run/cdi` +- The names you enter match what the runtime sees (check with `nvidia-ctk cdi list` for NVIDIA, `amd-ctk cdi list` for AMD) + +An `unresolvable CDI devices` error almost always means a name mismatch. + +### Notes + +- CDI takes effect at **creation** time: after changing the configuration you usually need to **recreate** the container — stop/start does **not** swap attached devices. +- The image still needs the right userspace libraries and tools to actually run CUDA/ROCm software. +- Once created, the **Workspace** tab lists the attached devices for verification. +- Backend support is in the table above — only `containerd` supports CDI. diff --git a/docs/tts-providers/edge.md b/docs/tts-providers/edge.md deleted file mode 100644 index d110f18..0000000 --- a/docs/tts-providers/edge.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: false -title: Redirecting ---- - - - - - -Redirecting to [/integrations/providers/tts/edge](/integrations/providers/tts/edge). diff --git a/docs/tts-providers/index.md b/docs/tts-providers/index.md deleted file mode 100644 index d110f18..0000000 --- a/docs/tts-providers/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: false -title: Redirecting ---- - - - - - -Redirecting to [/integrations/providers/tts/edge](/integrations/providers/tts/edge). diff --git a/docs/use-cases/code-and-preview.md b/docs/use-cases/code-and-preview.md new file mode 100644 index 0000000..3c94e10 --- /dev/null +++ b/docs/use-cases/code-and-preview.md @@ -0,0 +1,17 @@ +# Build and Preview in the Cloud + +**Owns:** a small project built in its own workspace, running where you can see it. + +**Uses:** [Agents / ACP](../guides/acp.md) · [Workspace](../guides/container.md) · [Skills](../guides/skills.md) + + + +## Start with + +> Build a reading-list web page in your workspace: add items, mark them finished, filter by theme. When it works, start the dev server and tell me how to preview it. Commit every change locally with git — do not push to any remote. + +## How it runs + +Prefer Claude Code or Codex? Attach your own subscription on the bot's **Agent** tab; it keeps working in the same workspace, on the same files. + + diff --git a/docs/use-cases/data-upkeep.md b/docs/use-cases/data-upkeep.md new file mode 100644 index 0000000..f78a8a5 --- /dev/null +++ b/docs/use-cases/data-upkeep.md @@ -0,0 +1,17 @@ +# A Living Spreadsheet + +**Owns:** one data file that the bot creates, updates on schedule, and reports changes to first. + +**Uses:** [Workspace](../guides/container.md) · [Files](../guides/files.md) · [Scheduled Tasks](../guides/schedule.md) + + + +## Start with + +> Create a competitor pricing sheet (CSV) in your workspace. Check each vendor's site every morning and append any changes to the sheet; message me first if a price drops. Maintain this file only — do not send anything to anyone else. + +## How it runs + +The workspace is a real filesystem with a terminal (Python, Node.js, and uv preinstalled), so cleaning CSVs, running scripts, and generating reports all happen in place. Browse the output any time under **Files**. + + diff --git a/docs/use-cases/gated-web-tasks.md b/docs/use-cases/gated-web-tasks.md new file mode 100644 index 0000000..498cb19 --- /dev/null +++ b/docs/use-cases/gated-web-tasks.md @@ -0,0 +1,17 @@ +# Screen Work Behind Logins + +**Owns:** web tasks that need eyes on a screen: console checks, form flows, OAuth. + +**Uses:** [Browser / Computer Use](../guides/browser-computer-use.md) · [Workspace](../guides/container.md) (visible desktop) + + + +## Start with + +> Open our admin console and verify the configuration against the checklist I give you, saving a screenshot of each item into the workspace. If you hit a login, a CAPTCHA, or anything you are unsure about, stop and wait for me to take over the desktop; continue after I hand it back. Read-only throughout — change no settings. + +## How it runs + +The visible desktop works both ways: watch it work in the desktop pane, or take over the keyboard to type a password, then hand control back. The browser session stays in the workspace, so the next task is already signed in. + + diff --git a/docs/use-cases/group-duty-assistant.md b/docs/use-cases/group-duty-assistant.md new file mode 100644 index 0000000..f385eae --- /dev/null +++ b/docs/use-cases/group-duty-assistant.md @@ -0,0 +1,17 @@ +# Group On-Call Assistant + +**Owns:** secretary duty in a team group: answers when mentioned and posts a daily recap. + +**Uses:** [Platforms](../integrations/channels/index.md) · [Sessions](../guides/sessions.md) · [Access Control](../guides/access.md) · [Scheduled Tasks](../guides/schedule.md) + + + +## Start with + +> Once you join this group: when someone mentions you, summarize the day's discussion and open items. Every day at 6pm, post a recap organized as decisions / to-dos / open questions. Post only in this group — never message anyone privately. + +## How it runs + +Use the "group only" [Access Control](../guides/access.md) preset to fence its territory. In discuss sessions the bot decides for itself whether it has anything worth saying, so it will not flood the channel. + + diff --git a/docs/use-cases/index.md b/docs/use-cases/index.md new file mode 100644 index 0000000..6aa91df --- /dev/null +++ b/docs/use-cases/index.md @@ -0,0 +1,25 @@ +# Use Cases + +Ready-to-follow scenarios that combine multiple Memoh features to solve real problems. Each scenario has its own chapter: what the bot owns, which features it uses, and how it comes together. + +A good bot **owns a repeatable outcome**, not a loose category of questions. Every example starts with read-only work — check the output first, then grant more. + +| Scenario | Owns | +|----------|------| +| [Morning Digest](./morning-briefing.md) | One message that starts your workday with everything you care about | +| [Release Watch](./release-watch.md) | An external change you are waiting for, reported the moment it happens | +| [Group On-Call Assistant](./group-duty-assistant.md) | Answering in a team group and posting the daily recap | +| [A Living Spreadsheet](./data-upkeep.md) | One data file: created, updated on schedule, changes reported first | +| [Screen Work Behind Logins](./gated-web-tasks.md) | Web tasks that need eyes on a screen: checks, forms, authorization | +| [Build and Preview in the Cloud](./code-and-preview.md) | A small project built in its own workspace, running where you can see it | +| [An Assistant That Remembers](./personal-assistant.md) | Your preferences and project state, carried across sessions and platforms | + +## From Example to Routine + +1. **Start read-only.** Let it read and prepare; review a few outputs before granting writes or execution. +2. **Put constraints in the instructions.** Outcome, sources, constraints, format, checkpoints — spell out all five (see [Quick Start](../guides/quick-start.md)). +3. **Save repeated flows as [Skills](../guides/skills.md).** One sentence should invoke the whole routine. +4. **Add a [Schedule](../guides/schedule.md) only once the flow is stable.** Trial-run with Max Calls first. +5. **Keep writes and external actions behind approval,** even after the routine feels safe. +6. **Fence who can command it with [Access Control](../guides/access.md)** — especially bots that join group chats. +7. **Let [Memory](../guides/memory.md) hold your preferences.** A correction made once should stick. diff --git a/docs/use-cases/morning-briefing.md b/docs/use-cases/morning-briefing.md new file mode 100644 index 0000000..6c0980d --- /dev/null +++ b/docs/use-cases/morning-briefing.md @@ -0,0 +1,17 @@ +# Morning Digest + +**Owns:** one message that starts your workday with everything you care about. + +**Uses:** [Scheduled Tasks](../guides/schedule.md) · [Web Search Providers](../integrations/providers/web-search.md) · [Platforms](../integrations/channels/index.md) + + + +## Start with + +> Every weekday at 8am, summarize releases and notable issues from the repositories I follow over the last 24 hours, add today's weather, and send it to me as one digest. Cite a source for every item; if something is uncertain, say so instead of guessing. + +## How it runs + +The bot has a `schedule` tool: describe the timing in plain language and it registers the cron entry itself. Cap the first runs with **Max Calls** until the format looks right. + + diff --git a/docs/use-cases/personal-assistant.md b/docs/use-cases/personal-assistant.md new file mode 100644 index 0000000..8afba5e --- /dev/null +++ b/docs/use-cases/personal-assistant.md @@ -0,0 +1,17 @@ +# An Assistant That Remembers + +**Owns:** your preferences and project state, carried across sessions and platforms. + +**Uses:** [Memory](../guides/memory.md) · [Platforms](../integrations/channels/index.md) · [Scheduled Tasks](../guides/schedule.md) + + + +## Start with + +> Remember these preferences: mornings are for deep work, meetings go in the afternoon, and the weekly report is due Friday before end of day. From now on, check memory before scheduling reminders or writing summaries; if a preference is unclear, ask me instead of guessing. + +## How it runs + +With a [memory provider](../integrations/providers/memory/builtin.md) configured, "whatever happened with that PR?" is a question it can just answer. When memories pile up, run **Compact** to merge and dedupe. + + diff --git a/docs/use-cases/release-watch.md b/docs/use-cases/release-watch.md new file mode 100644 index 0000000..eeebdb8 --- /dev/null +++ b/docs/use-cases/release-watch.md @@ -0,0 +1,17 @@ +# Release Watch + +**Owns:** an external change you are waiting for, reported the moment it happens. + +**Uses:** [Scheduled Tasks](../guides/schedule.md) · [Workspace](../guides/container.md) · [Platforms](../integrations/channels/index.md) + + + +## Start with + +> Watch this project's releases page and check every 30 minutes. When a new version ships, write the changes up as Markdown in your workspace and ping me once on Telegram. Organize only — do not run any upgrade or install anything. + +## How it runs + +"It's there even when you're not" is schedules plus proactive messages: check on a timer, speak only when something changed. The same pattern watches prices, stock, or document updates. + + diff --git a/docs/zh/guides/connectors.md b/docs/zh/guides/connectors.md deleted file mode 100644 index ea64a16..0000000 --- a/docs/zh/guides/connectors.md +++ /dev/null @@ -1,72 +0,0 @@ -# 连接器 - -连接器让 Bot 能用上第三方服务(GitHub、Notion 这类)。在应用市场里挑一个服务,走 OAuth 授权或者填 API Key,绑到某个 Bot 上——之后对话里 Bot 就能直接调这个服务的工具。 - -背后接的是 [Connect-It](https://github.com/memohai/connect-it),一个和 Memoh 一起部署的配套服务。所有凭据(OAuth token、API Key)都存在 Connect-It 那边;Memoh 只存一张绑定表——哪个 Bot 绑了哪个连接、工具命名空间叫什么、开没开。 - ---- - -## 前提 - -服务端配置了 Connect-It 地址,连接器功能才会出现: - -```toml -[connect_it] -base_url = "" # 例如 "http://connect-it:8421" -api_token = "" # 服务端之间的可信 token -``` - -两项留空即关闭该功能。线上环境建议用对应的环境变量(`MEMOH_CONNECT_IT_BASE_URL`、`MEMOH_CONNECT_IT_API_TOKEN`)。 - -一键 Server Deploy 会在全新安装时自动带起一个同机部署的 Connect-It,见 [Server Deploy](../self-hosted/docker.md#connect-it-连接器)。没配置 Connect-It 时,应用市场不会显示 **Connectors** tab,连接器相关操作会提示服务器未配置连接器。 - ---- - -## 连接一个服务 - -1. 在客户端打开 **应用市场**。 -2. 停在 **Connectors** tab——配置了连接器时它排在第一个,也是默认落地的 tab。 -3. 选一个连接器,点 **Connect**。 -4. 选择目标 Bot。 -5. 选认证方式——OAuth 还是 API Key,取决于这个连接器支持什么。 -6. OAuth 走弹窗完成授权;浏览器拦了弹窗的话,给页面放行弹窗再试。API Key 则填好凭据字段。 -7. 连接会出现在该 Bot 的 **Connectors** tab 里。 - ---- - -## 管理连接 - -Bot 详情页有一个 **Connectors** tab,列出这个 Bot 连了哪些服务。每条连接会显示状态: - -| 状态 | 含义 | -|------|------| -| **Connected** | 正常,工具对 Bot 可用 | -| **Waiting for authorization** | 连接建了但 OAuth 没走完;补完授权,或者断开它 | -| **Authorization required** | 凭据过期或被撤销,点 **Reauthorize** 重新授权 | -| **Authorization failed** | 上次授权没成功,可再点 **Reauthorize** 重试 | -| **Unavailable** | 这个连接器在 Connect-It 侧已经下架 | -| **Disabled** | 已停用,工具不会给到 Bot | - -在这个 tab 里可以: - -- **启用 / 停用**某条连接,不用删掉它。 -- **Reauthorize** 重新授权凭据失效的连接。 -- **Disconnect** 断开连接——会把绑定从 Bot 上移除,**并且**删掉 Connect-It 里存的这条连接(含凭据)。 - -OAuth 授权中途放弃的话,这条连接会一直停在 **Waiting for authorization**,手动断开即可清理。 - ---- - -## 工具怎么到 Bot 手上 - -对话时,Memoh 会把这个 Bot 所有启用且状态正常的连接聚合成一个 MCP 会话,作为工具源给智能体。连接器工具和 workspace、MCP 工具并排出现。 - -每条连接在绑定那一刻会拿到一个按连接器类型生成的**工具命名空间**——GitHub 连接是 `github`,再连一个就是 `github-2`。命名空间在绑定的整个生命周期内固定不变:之后增删其它连接,不会影响已有连接的工具名。 - ---- - -## 相关页面 - -- [应用市场](./supermarket.md) —— 发现和连接服务的入口。 -- [MCP](./mcp.md) —— 直接管理 MCP 连接。 -- [Server Deploy](../self-hosted/docker.md#connect-it-连接器) —— 同机部署 Connect-It、凭据管理和 OAuth 回调地址。 diff --git a/docs/zh/guides/container.md b/docs/zh/guides/container.md index f6b875b..d445f74 100644 --- a/docs/zh/guides/container.md +++ b/docs/zh/guides/container.md @@ -1,114 +1,58 @@ -# 工作区(Workspace)与容器 +# 工作区 -每个 Bot 都在一个 workspace 里工作。Server Deploy 里通常是隔离容器、Pod 或类似 VM 的 runtime;在受信任的 Desktop/local 场景里,也可以是宿主机上的本地目录。workspace 提供文件系统、命令执行环境、MCP runtime,以及可选的图形桌面。 +每个 Bot 都有自己的**工作区**——一台属于它的电脑:真实的文件系统、能执行命令的终端、预装好的工具链,还可以开一块看得见的桌面。你交给 Bot 的文件、它产出的结果、它装的工具,都住在这里,跨会话保留。 -## 是什么 +## 它能干什么 -可以把 workspace 想成 Bot 私用的一台小电脑。它能: +- 存文件、改文件——你随时能在 **文件** 标签页里看 +- 跑脚本、装包:预装 **Node.js** 和 **Python**(`pip`、`uv` 都在 PATH 上),不用先折腾解释器 +- 挂后台任务 +- 跨会话保留状态——昨天没做完的,今天接着做 +- 可选地运行可视化桌面和有头浏览器 -- 存文件、改文件 -- 在镜像允许时装包 -- 跑脚本和后台任务 -- 跨会话保留状态 -- 可选地运行桌面显示和有头浏览器 +## 在客户端里的入口 -workspace toolkit 自带 **Node.js** 和 **Python** 两套运行时(`pip`、`uv` 都在 PATH 上),Bot 跑 Python 脚本、装包不用先折腾解释器。 +Bot 详情页里这几个标签页都对着工作区: -底层容器 runtime 由 `config.toml` 的 `[container].backend` 决定,trusted local workspace 另行控制。官方 Docker Compose Server Deploy 使用 `containerd`;Docker Engine、Apple 和 local workspace 的差异见 [Workspace backend](../self-hosted/workspace-backends.md)。 +| 标签页 | 内容 | +|--------|------| +| **工作区** | 工作区的状态与生命周期:创建、启动、停止;运行信息、快照、导入导出 | +| **文件** | 浏览和编辑工作区文件系统 | +| **终端** | 在工作区里打开交互 shell | +| **桌面** | 可视化桌面:实时画面,接管 / 交还键鼠控制 | +| **网络** | 工作区网络状态 | +| **应用** | 装进这个工作区的 App——技能、依赖、连接器(见[应用市场](./supermarket.md)) | -## Workspace 相关 tab +## 生命周期 -Bot 详情页里有几组和 workspace 相关的 tab: +在 **工作区** 标签页管理: -| Tab | 内容 | -|-----|------| -| **工作区** | 容器生命周期、快照、导入导出、CDI 设备。 | -| **Desktop** | Workspace display runtime、有头浏览器可用性、实时 display session、关闭会话。 | -| **Network** | Workspace 网络与 overlay provider 状态/动作。 | -| **Tool Approval** | 需要人类确认的工具审批设置。 | -| **Files** | 浏览和编辑 Bot workspace 文件系统。 | -| **Terminal** | 在当前 workspace runtime 里打开交互 shell。 | +- **创建**:按模板建一个新工作区,过程有进度展示。 +- **启动 / 停止**:不用时停掉省资源,内容不丢。 +- **删除**:删掉这个运行实例。 -如果 Bot 使用 trusted local workspace,一些只适用于容器 runtime 的 tab 或按钮可能会隐藏或不可用。 +终端、桌面等大多数能力都需要工作区**正在运行**;装应用、更新应用也一样。标签页里同时会显示运行状态、镜像和后台任务数等运行信息。 -## 容器生命周期 +## 可视化桌面 -在 **工作区** tab 管容器型 workspace: +**桌面** 标签页用来启用和查看图形桌面。启用后,Bot 可以在工作区里跑**有头浏览器**,你在桌面面板里看到的和它操作的是同一块屏幕: -- **Create**:没有就按镜像建;拉镜像、建实例时会有 SSE 进度。 -- **Start**:启动 workspace runtime。 -- **Stop**:省资源,优雅停。 -- **Delete**:删除 runtime 实例。 +- 实时观看它的每一步操作 +- 随时**接管**键鼠——输密码、过验证码——再把控制权**交还** +- 浏览器会话保留在工作区里,下次任务免登录 -终端、容器 display 等很多 workspace 能力都需要 runtime 正在运行。 - -## Workspace display - -**Desktop** tab 用来准备和检查图形 workspace runtime。它会检查 desktop toolkit、Xvnc/VNC、浏览器和当前 display session。 - -启用后,workspace 可以在容器里跑有头 Chrome/Chromium。客户端的 **桌面** 面板会连接到同一个桌面会话,你和 agent 看到、操作的是同一个可见浏览器。工具层面的区别见 [Browser / Computer Use](./browser-computer-use.md)。 - -## 运行时信息 - -**工作区** tab 会显示: - -- container id 与状态 -- 镜像 -- 宿主机和 workspace 路径 -- 后台任务数 -- 若配置了 CDI 设备,也会列出实际挂载的设备 - -## 进阶:CDI 设备 - -要把宿主机通过 **CDI**(常见是 GPU)透进容器,在 **工作区** -> **Advanced** 里配。一般只有确实要在里面跑 CUDA/ROCm 等才要动。 - -### 配法 - -1. 打开 **工作区**。 -2. 没有容器先 **Create**;要改 GPU 类设置往往要**重建**容器。 -3. 展开 **Advanced**。 -4. 开 **GPU**,在 **CDI devices** 里写设备名。 - -可每行一个或逗号分隔,例如: - -- `nvidia.com/gpu=0` -- `nvidia.com/gpu=all` -- `amd.com/gpu=0` -- `amd.com/gpu=all` - -### 宿主要求 - -宿主机上驱动、厂商工具、CDI spec 要已就绪。通常意味着: - -- 宿主机上 GPU 本来就能用 -- `/etc/cdi` 或 `/var/run/cdi` 里有 spec -- 你填的名字和运行时看见的一致 - -查本机名: - -- NVIDIA:`nvidia-ctk cdi list` -- AMD:`amd-ctk cdi list` - -若报 `unresolvable CDI devices`,多半是名字对不上。 - -### 注意 - -- CDI 在**创建**时生效,改配置后常要**重建**容器;只停再起**不会**换已挂设备。 -- 镜像里仍要装对的用户态库和工具,才能真正跑 CUDA/ROCm 软件。 -- 建好后 **工作区** tab 会显示当前挂上的设备,便于核对。 +工具层面的差别见 [Browser / Computer Use](./browser-computer-use.md)。 ## 快照 -**Create Snapshot** 会记录当前容器 workspace 状态,方便回滚、版本化 runtime 或试大改。**Restore** 按某个快照回退,可删不要的快照。 +**创建快照**记录工作区当前状态,适合在大改之前留一个回滚点;**恢复**按某个快照回退,不要的快照可删。 ## 导入导出 -**工作区** tab 支持导入导出 workspace 数据: - -- **Export Data**:把 workspace 文件系统数据打成包下载。 -- **Import Data**:从本地上传归档并解进 workspace 文件系统。 -- **Restore**:把数据目录重置到干净状态,适合文件系统损坏或想从零开始而又不重建 runtime 实例时。 - -## 版本 +- **导出数据**:把工作区文件打包下载。 +- **导入数据**:上传归档并解进工作区。 +- **重置**:把数据目录恢复到干净状态——文件系统乱了、想从头开始时用。 -Memoh 会跟踪 workspace/container 版本,帮助审计 runtime 环境何时、因何变过。 +::: tip 自部署相关 +工作区跑在哪种运行时(containerd、Docker、Apple container、受信本地目录),以及 GPU 等宿主设备怎么透传给工作区,属于服务端的部署配置,见 [Workspace 后端](../self-hosted/workspace-backends.md)。Memoh Cloud 用户不需要关心这些。 +::: diff --git a/docs/zh/guides/extensions.md b/docs/zh/guides/extensions.md index 680a14c..d1ae42b 100644 --- a/docs/zh/guides/extensions.md +++ b/docs/zh/guides/extensions.md @@ -7,8 +7,8 @@ Memoh 有五种给 Bot 加能力的方式。单看名字很容易混,摆在一 | [技能](./skills.md) | 改变 Bot 做事方式的 `SKILL.md` 提示模块 | 在 Bot 工作区的 `/data/skills/` 下,从 **Skills** 标签页管理;在对话中唤起 | 那些本来每次都要重打一遍的流程和工作习惯 | | [Hooks](./hooks.md) | 写在 `hooks.json` 里、可以运行命令或工具的事件规则 | 在 `/data/.memoh/hooks.json`,从 **Hooks** 标签页编辑;在 `PreToolUse`、`TurnEnd` 这类生命周期事件上触发 | 固定节点上的检查和附带动作,全程不经过聊天 | | [MCP](./mcp.md) | 到外部 MCP 工具服务器的连接 | 按 Bot 在 **MCP** 标签页配置,Stdio 或 Remote 连接;发现的工具在对话中使用 | 接入一个本身就带 MCP server 的工具 | -| [连接器](./connectors.md) | 到 GitHub、Notion 这类服务的 OAuth 或 API Key 绑定 | 从应用市场的 **Connectors** 标签页连接,在 Bot 的 **Connectors** 标签页管理;服务的工具出现在对话里 | 让 Bot 用你在某个托管服务上的账号做事 | -| [应用市场](./supermarket.md) | Memoh 内置目录:一键安装打包好的应用——技能连同它的依赖和连接器 | 在 **设置** 下;装好的内容落进目标 Bot 自己的各个标签页 | 直接拿到现成能力,不用自己拼零件 | +| [连接器](../self-hosted/connectors.md) | 到 GitHub、Notion 这类服务的 OAuth 或 API Key 绑定 | 作为应用的组件随 App 安装,在 Bot 的 **应用** 标签页授权和管理;服务的工具出现在对话里 | 让 Bot 用你在某个托管服务上的账号做事 | +| [应用市场](./supermarket.md) | Memoh 内置目录:一键安装打包好的应用——技能连同它的依赖和连接器 | 从侧边栏打开;装好的内容落进目标 Bot 的工作区和 **应用** 标签页 | 直接拿到现成能力,不用自己拼零件 | 不管能力从哪条路进来,最后都汇到同一个地方:连接器和 MCP 的工具在对话里与工作区工具并列出现,装好的技能出现在 Bot 的 **Skills** 标签页里,和手写的没有两样。 @@ -17,7 +17,7 @@ Memoh 有五种给 Bot 加能力的方式。单看名字很容易混,摆在一 - 想改 Bot 的做事方式 → [技能](./skills.md)。 - 想在某个事件点自动做事 → [Hooks](./hooks.md)。 - 想接一个有 MCP server 的工具 → [MCP](./mcp.md)。 -- 想让 Bot 用你的 GitHub/Notion 账号 → [连接器](./connectors.md)。 +- 想让 Bot 用你的 GitHub/Notion 账号 → [连接器](../self-hosted/connectors.md)。 - 想一键装现成的一套 → [应用市场](./supermarket.md)。 ::: tip 它们可以叠着用 @@ -31,7 +31,7 @@ Memoh 有五种给 Bot 加能力的方式。单看名字很容易混,摆在一 - [技能](./skills.md)——`SKILL.md` 的写法、技能状态、收编发现的技能。 - [Hooks](./hooks.md)——事件目录、配置结构、怎么测试一条规则。 - [MCP](./mcp.md)——Stdio 与 Remote 连接、OAuth、工具发现。 -- [连接器](./connectors.md)——连接状态、重新授权、工具命名空间。 +- [连接器](../self-hosted/connectors.md)——连接状态、重新授权、工具命名空间。 - [应用市场](./supermarket.md)——浏览目录、安装到 Bot。 拿不定主意就先逛应用市场——装一个现成的包,先看看成品长什么样,再动手搭自己的。 diff --git a/docs/zh/guides/index.md b/docs/zh/guides/index.md index 906d23f..fa134a8 100644 --- a/docs/zh/guides/index.md +++ b/docs/zh/guides/index.md @@ -9,7 +9,6 @@ - **[概览](./overview.md)**:Memoh 是什么,各个部件如何搭在一起。 - **[快速开始](./quick-start.md)**:安装应用、登录、创建第一个 Bot、交给它真实任务,并接入聊天平台。 - **[和 Bot 协作](./working-with-bots.md)**:什么任务适合交给 Bot、请求怎么说、什么时候拆多个 Bot——外加逐 tab 的配置参考。 -- **[用户偏好](./preferences.md)**:配置界面语言、主题、字体、图表和快捷键。 - **[会话](./sessions.md)**:理解 chat、discuss、路由和状态区。 - **[文件](./files.md)**:浏览和编辑 Bot workspace 文件。 - **[斜杠命令](./slash-commands.md)**:用命令快捷完成日常控制。 @@ -26,7 +25,7 @@ - **[Workspace](./container.md)**:从产品界面理解 workspace 行为。 - **[Browser / Computer Use](./browser-computer-use.md)**:使用有头浏览器和可见桌面会话。 - **[技能](./skills.md)** 和 **[应用市场](./supermarket.md)**:添加可复用提示模块和模板。 -- **[连接器](./connectors.md)**:接入 GitHub、Notion 等第三方服务。 +- **[连接器](../self-hosted/connectors.md)**:接入 GitHub、Notion 等第三方服务。 - **[Hooks](./hooks.md)** 和 **[MCP](./mcp.md)**:连接工具、自动化规则和外部数据源。 - **[长期记忆](./memory.md)**:配置好记忆提供方后管理长期记忆。 - **[上下文压缩](./compaction.md)**:缩小当前会话上下文占用。 @@ -35,7 +34,7 @@ ## 使用场景 -- **[使用场景](./use-cases.md)**:组合多种功能解决实际问题的即用型示例。 +- **[使用场景](../use-cases/index.md)**:组合多种功能解决实际问题的即用型示例。 ## 获取帮助 diff --git a/docs/zh/guides/overview.md b/docs/zh/guides/overview.md index cb4b2bc..e75b0e7 100644 --- a/docs/zh/guides/overview.md +++ b/docs/zh/guides/overview.md @@ -24,7 +24,7 @@ Memoh 给每个 Bot 一台自己的云电脑:带真实文件系统和终端的 > 每周五 17:00,把我这一周发给你的链接和文件整理成一份周报,按主题分组、每条一句话,存进工作区并把摘要发到这个对话。只整理我发给你的内容,不要外发给任何人。 -Bot 会自己登记定时任务并按周交付。先从只读的活儿开始,检查过几次产出,再逐步放开写入和执行——更多现成搭配见 [使用场景](./use-cases.md)。 +Bot 会自己登记定时任务并按周交付。先从只读的活儿开始,检查过几次产出,再逐步放开写入和执行——更多现成搭配见 [使用场景](../use-cases/index.md)。 ## 常见问题 @@ -51,7 +51,7 @@ Bot 会自己登记定时任务并按周交付。先从只读的活儿开始, ## 下一步 - [快速开始](./quick-start.md)——从装应用到接入聊天平台,十五分钟。 -- [使用场景](./use-cases.md)——组合多种功能解决实际问题的即用示例。 +- [使用场景](../use-cases/index.md)——组合多种功能解决实际问题的即用示例。 - [Bot](./working-with-bots.md)——逐个标签页配置一个 Bot。 - [渠道](../integrations/channels/index.md)——各聊天平台的接入方法。 - [帮助中心](https://memoh.ai/help)——订阅、账单与账号问题。 diff --git a/docs/zh/guides/preferences.md b/docs/zh/guides/preferences.md deleted file mode 100644 index 4d6c1d8..0000000 --- a/docs/zh/guides/preferences.md +++ /dev/null @@ -1,100 +0,0 @@ -# 偏好设置 - -Memoh v0.13 提供客户端级别的用户偏好设置。它们会改变当前设备配置档里的界面观感和快捷键行为,不会改变 Bot 的人格、模型、工具、记忆或访问规则。 - -打开 **Settings**,在 **Appearance** 调整视觉偏好,在 **Keyboard** 调整快捷键。 - ---- - -## 外观 - -**Appearance** 页面分为界面、字体与字号、代码高亮、图表几个部分。修改会立即生效。 - -### 界面 - -| 设置 | 作用 | -|------|------| -| **Language** | 设置界面语言。v0.13 包含 English、简体中文和日本語。如果还没有手动选择,Memoh 会根据浏览器语言识别英文、中文或日文,并在无法识别时回退到英文。 | -| **Theme** | 选择 Light、Dark 或 System。System 会跟随操作系统或浏览器的颜色模式。 | -| **Color Scheme** | 更换品牌元素、状态颜色和界面控件使用的强调色方案。可选 Memoh、Ocean、Forest、Rose、Amber。 | - -这里的语言只影响 Memoh 界面。Bot 回复时使用什么语言,仍在 Bot 设置里配置。 - -### 字体与字号 - -如果界面太小、太大,或你想换代码字体,可以在这里调整。 - -| 设置 | 影响范围 | 范围 / 默认值 | -|------|----------|---------------| -| **UI Font Size** | 常规界面文字和控件 | `12`-`20` px,默认 `16` | -| **Code Font Size** | 代码编辑器、Markdown 代码块和终端文字 | `11`-`20` px,默认 `13` | -| **UI Font Family** | 主界面字体 | 默认 `system-ui, sans-serif` | -| **Code Font Family** | 代码、编辑器和终端字体栈 | 默认 `ui-monospace, monospace` | - -字体字段接受普通 CSS 风格的字体栈,例如 `Inter, system-ui, sans-serif` 或 `"JetBrains Mono", ui-monospace, monospace`。对应字体需要已经存在于你的设备或浏览器环境中。清空字段,或填入默认值,可以回到 Memoh 默认字体栈。 - -### 代码高亮 - -Memoh 使用 Shiki 主题渲染代码高亮。你可以分别选择浅色模式和深色模式下的主题: - -| 设置 | 影响范围 | -|------|----------| -| **Light theme** | 界面处于浅色模式时的代码块和编辑器 | -| **Dark theme** | 界面处于深色模式时的代码块和编辑器 | - -主题选择器会搜索内置 Shiki 主题列表,并显示实时预览,方便你在离开页面前对比浅色和深色选择。 - -### 图表 - -聊天和 Markdown 预览中渲染的 Mermaid 图表会使用 **Mermaid Theme** 偏好。 - -| 主题 | 行为 | -|------|------| -| **Auto** | 跟随当前界面模式。 | -| **Default** | 使用 Mermaid 默认浅色主题。 | -| **Dark** | 使用 Mermaid 深色主题。 | -| **Forest** | 使用 Mermaid forest 主题。 | -| **Neutral** | 使用 Mermaid neutral 主题。 | - -如果某个图表已经写了自己的 Mermaid 初始化指令,它可能会保留文档作者指定的主题;这适合需要固定图表风格的文档。 - ---- - -## 快捷键 - -**Keyboard** 页面会按作用域列出可编辑快捷键。点击某一行的 **Edit**,按下新的组合键,然后保存。 - -### 默认快捷键 - -macOS 上显示为 `Cmd`,Windows 和 Linux 上显示为 `Ctrl`。 - -| 动作 | 默认快捷键 | 作用域 | -|------|------------|--------| -| 关闭当前工作区标签页 | 桌面应用中为 `Cmd/Ctrl + W`。在普通浏览器里,浏览器会保留原生关闭标签页行为。 | 全局 | -| 保存当前文件 | `Cmd/Ctrl + S` | 全局 | -| 切换侧边栏 | `Cmd/Ctrl + B` | 全局 | -| 打开设置 | `Cmd/Ctrl + K` | 全局 | -| 关闭媒体灯箱 | `Esc` | 媒体灯箱 | -| 上一张媒体 | `Left Arrow` | 媒体灯箱 | -| 下一张媒体 | `Right Arrow` | 媒体灯箱 | - -全局快捷键在应用内普遍生效。媒体灯箱快捷键只在媒体预览覆盖层打开时生效。 - -### 修改规则 - -保存快捷键前,Memoh 会先检查组合键: - -- `Cmd/Ctrl + W`、`Cmd/Ctrl + Q`、`Cmd/Ctrl + T`、`Cmd/Ctrl + N` 保留给浏览器或操作系统。 -- 全局快捷键必须包含 `Cmd/Ctrl` 或 `Alt`,避免普通输入时误触应用命令。 -- 同一作用域内,两条快捷键不能使用同一个组合键。 -- 不同作用域可以共用组合键,但 Memoh 会提示警告,因为只有当前活跃的作用域会处理它。 - -用某一行的重置按钮可以恢复单个快捷键。用 **Reset all** 可以清空所有自定义快捷键。 - ---- - -## 实用说明 - -- 外观和快捷键是个人 UI 偏好,不会影响其他用户或 Bot。 -- 偏好保存在当前设备/浏览器配置档里,换浏览器或换机器后可能需要重新设置。 -- 如果试字体或快捷键后界面不合预期,可以回到同一页面重置对应字段或快捷键。 diff --git a/docs/zh/guides/quick-start.md b/docs/zh/guides/quick-start.md index 437a428..e6baffe 100644 --- a/docs/zh/guides/quick-start.md +++ b/docs/zh/guides/quick-start.md @@ -115,11 +115,11 @@ Bot 在你本来就聊天的地方最有用。 | 逐个标签页配置 Bot | [Bot](./working-with-bots.md) | | 理解聊天、讨论与消息路由 | [会话](./sessions.md) | | 运行定时或周期任务 | [定时任务](./schedule.md) | -| 接入外部工具和数据 | [MCP](./mcp.md)、[连接器](./connectors.md) | +| 接入外部工具和数据 | [MCP](./mcp.md)、[连接器](../self-hosted/connectors.md) | | 安装现成的能力 | [应用市场](./supermarket.md) | | 在生命周期节点挂自己的逻辑 | [钩子](./hooks.md) | | 控制谁能跟 Bot 说话 | [访问控制](./access.md) | -| 看看别人怎么用 | [使用场景](./use-cases.md) | +| 看看别人怎么用 | [使用场景](../use-cases/index.md) | ::: tip 需要帮助? 订阅、credits 或账号相关的问题,以及本文档没有覆盖的疑问,都可以在 [帮助中心](https://memoh.ai/help) 找到答案,也可以从那里联系 Memoh 团队。 diff --git a/docs/zh/guides/skills.md b/docs/zh/guides/skills.md index f6fbd8a..1afefb5 100644 --- a/docs/zh/guides/skills.md +++ b/docs/zh/guides/skills.md @@ -1,16 +1,14 @@ # 技能 -**技能**是可复用的提示模块,用来改 Bot 的语气、行为方式、工具使用习惯。在 Bot 的 **Skills** tab 里管;可手写,也可从 [应用市场](./supermarket.md) 装。 +**技能(Skill)**是可复用的提示模块,用来教 Bot 一套固定做法:语气、流程、工具使用习惯。技能没有单独的管理界面——它就是工作区里的文件,放对目录就会被加载。 ::: tip 限制 一次会话最多同时请求 5 个技能;单个技能注入上限 64 KiB,合计上限 256 KiB。这些上限不可配置。 ::: ---- - ## 长什么样 -就是带 YAML 头的 `SKILL.md`,至少要有稳定的 `name` 和短 `description`。 +一个技能是一个目录,里面放一份带 YAML 头的 `SKILL.md`,至少要有稳定的 `name` 和短 `description`。正文就是真正注入给 Agent 的说明: ```yaml --- @@ -23,112 +21,33 @@ description: Enables advanced coding workflows and tool usage. 你写清楚代码、说明取舍,该用文件/命令工具时就用。 ``` -建议: - -- 名字用简单 ASCII,如 `coder-skill`、`research`,别带空格;Memoh 会拿它当目录名。 -- 正文就是真正要注入到运行时的说明。 +名字用简单 ASCII(如 `coder-skill`、`research`),别带空格——它同时也是目录名。 ---- +## 放到哪个目录 -## 从哪来 +自己写的技能,放进 Bot 工作区的这个目录: -分 **托管** 和 **发现**: +```text +/data/skills/user/personal/<技能名>/SKILL.md +``` -- **托管**:你在 Memoh 里建、改、从应用市场装的,放在 `/data/skills//SKILL.md`。 -- **发现**:容器里旧目录、导入镜像里带来的兼容路径。 +怎么放都行:在 Bot 的 **文件** 标签页里直接建目录写文件,在 **终端** 里操作,或者干脆让 Bot 自己建——工作区自带一个 `skill-creator` 技能,描述清楚你要的流程,它会把文件写到正确的位置。 -Memoh 按顺序扫这些根: +其它目录你会见到,但**不该手动往里放东西**: -| 类型 | 根路径 | +| 目录 | 归谁管 | |------|--------| -| 托管 | `/data/skills/` | -| 旧版发现 | `/data/.skills/` | -| 兼容 | `/data/.agents/skills/` | -| 兼容 | `/root/.agents/skills/` | - -每个根下可以直接放 `SKILL.md`,或子目录如 `/data/skills/coder-skill/SKILL.md`。 - -**同名**技能可能多份来源,会进入不同状态(见下)。 - ---- - -## 状态 - -每个来源会标: - -| 状态 | 含义 | -|------|------| -| `effective` | 这个名字当前**真在用**的这一份 | -| `shadowed` | 同名有别的来源优先了 | -| `disabled` | 这一份被关掉,不用 | - -记死一点:**技能名是身份**。多个 `coder-skill` 只能有一个 `effective`。 - -### 常见情况 - -- 刚在 Memoh 里建的多半是托管 + `effective`。 -- 老目录里有一份时,可能先由它 `effective`,直到你装了托管同名。 -- 把发现的那份 **Adopt** 成托管后,通常托管变 `effective`,旧来源变 `shadowed`。 -- 关掉 `effective` 那一份,同名里下一位可能顶上来。 - ---- - -## 在界面里 - -### 添加 - -**Add Skill** → 在编辑器里写 raw Markdown → 保存,写到托管目录。 - -### 编辑 - -**Edit** 改 `SKILL.md`;自己托管的改起来最直接。 +| `/data/skills/user/personal/` | **你**。手写技能都放这里 | +| `/data/skills///` | [应用](./supermarket.md)。随 App 安装、更新、卸载,别手改 | +| `/data/.memoh/skills/` | 工作区模板的内置技能(如 `skill-creator`)。每次工作区初始化都会刷成模板版本,改了也会被覆盖;要定制就换个名字复制到自己的目录 | +| `/data/.skills/`、`/data/.agents/skills/` | 旧版兼容路径,仅作发现,不要新增 | -### 删除 +## 同名怎么办 -**Delete** 会去掉这份托管目录;若还有发现来源,可能那份又变成 `effective`。 - -### 禁用 / 启用 - -**Disable** 关某一条来源不删;**Enable** 再开。适合试回退、暂时不用某套提示。 - -### Adopt - -把**发现**来源复制进托管目录,方便你长期用界面改。已有托管同名时不能 Adopt。 - ---- - -## 运行时 - -只有 **effective** 会进当前 Bot 提示。 - -- `shadowed` 能看、不进提示 -- `disabled` 当不存在 -- 活跃会话的 **状态区** 也会显示这条路上用过哪些技能 - ---- - -## 模板自带的内置技能 - -Memoh 随 workspace 模板带了几个内置技能(如 `skill-creator`、`hooks-setup`),它们是**自动同步**的:workspace 每次初始化或对账时,内置副本都会刷成当前模板版本。 - -实际影响: - -- **别原地改内置技能**——下次刷新会被覆盖。要定制就换个名字复制一份(或 Adopt 成托管技能)。 -- 你自己放在旁边的技能不会被同步删掉。 -- 模板带的 workspace 文件(如 `AGENTS.md`)是另一种规则:只在缺失时创建,你的修改会保留。 - ---- - -## 应用市场和导入 - -- **应用市场安装**:下好的技能进托管目录,和手写一样。 -- **老环境/导入**:可能只出现在发现路径,需要就 **Adopt**。 - ---- +**技能名就是身份**:同名技能不管来自几个目录,同一时刻只有一份生效。你自己目录里的同名技能会盖过旧版兼容路径里的那份。想换掉某个 App 技能的行为,别去改它的文件——用一个新名字写你的版本。 -## 建议工作流 +## 建议 -1. 先少而精,名字和描述写清楚。 -2. 不确定删不删时先 **Disable**。 -3. 要长期留用的发现项用 **Adopt**。 -4. 能复用就从 [应用市场](./supermarket.md) 装,少复制粘贴多份。 +1. 先少而精,`name` 和 `description` 写清楚——Agent 靠描述决定要不要加载它。 +2. 重复出现的流程才值得固化成技能;一次性的要求直接说就行。 +3. 能复用就从[应用市场](./supermarket.md)装,少复制粘贴多份。 diff --git a/docs/zh/guides/supermarket.md b/docs/zh/guides/supermarket.md index 6409793..fda1eed 100644 --- a/docs/zh/guides/supermarket.md +++ b/docs/zh/guides/supermarket.md @@ -1,50 +1,44 @@ # 应用市场(Supermarket) -应用市场是 Memoh 内置的**连接器**和 **Skills** 目录。连接器把第三方服务(GitHub、Notion 这类)绑到 Bot 上;Skills 是 Agent 可按需加载的可复用流程。 +应用市场是 Memoh 内置的应用目录。这里的**应用(App)**是一个打包好的能力单元:一个 App 里可以带若干 **Skill**(可复用的流程说明)、若干**依赖**(要装进工作区的工具),以及若干**连接器**(GitHub、Notion 这类第三方服务的绑定)。装的是整个 App,不用再分别找 Skill 或连接器。 -客户端在 **设置** 下提供应用市场,分两个标签页: - -- **Connectors** -- **Skills** - -服务器[配置了 Connect-It](./connectors.md#前提) 时,**Connectors** 排在第一个,也是默认落地的 tab;没配置时这个 tab 不显示,默认落在 **Skills**。 +在客户端侧边栏打开 **应用市场**:应用按分类陈列,可搜索、按标签筛选。点进详情页能看到应用的说明、组件构成(多少个 Skill、依赖、连接器)、作者、版本、来源 Registry 和链接。 --- -## 连接一个服务 +## 安装一个应用 -**Connectors** tab 列出可以通过 OAuth 或 API Key 连给 Bot 的服务。挑一个点 **Connect**,选目标 Bot,完成授权即可。完整流程——认证方式、连接状态、工具怎么到 Bot 手上——见[连接器](./connectors.md)。 +1. 在 **应用市场** 挑一个应用,进入详情页。 +2. 点 **安装到 Bot**,选择目标 Bot。 +3. 应用声明了环境变量的,先把需要的值填好。 +4. 确认安装。 ---- +安装和更新需要该 Bot 的工作区处于运行状态:Skill 会写进工作区,依赖装进工作区,连接器建立绑定。安装过程有进度展示,中断了可以**继续安装**或**恢复安装**。 -## 安装 Skill +--- -1. 在客户端打开 **应用市场**。 -2. 切到 **Skills** tab。 -3. 选择一个 Skill 并点击 **Install**,或进入 Skill 详情页点击 **Install to Bot**。 -4. 选择目标 Bot。 -5. 确认安装。 -6. Skill 会出现在该 Bot 的 **Skills** tab 中。 +## 装好之后:Bot 的「应用」标签 -Skill 会安装到 Bot 工作区内的 managed skills 目录(`/data/skills/`)。Skill 详情页展示作者、版本、来源 registry 和链接。加载与使用方式见 [Skills](./skills.md)。 +Bot 详情页的 **应用** 标签列出已安装的 App,按组件展示状态: ---- +| 组件 | 去向 | +|------|------| +| **Skill** | 写进工作区的受管目录 `/data/skills///`,由应用管理——更新、卸载时一起处理,别手动改(见[技能](./skills.md)) | +| **依赖** | 装进该 Bot 的工作区,并与同工作区里需要它们的其他应用共享 | +| **连接器** | 标注**需要授权**、**可选**或**所有工作区共享**;点**去授权**完成 OAuth 或填入 API Key(见[连接器](../self-hosted/connectors.md)) | -## 配置应用市场 +常用操作:**检查更新**、**更新**、**卸载**。部分组件失败或还没授权时,应用会标成"需要处理",点开组件列表补齐即可。 -默认情况下,Memoh 会从这里读取应用市场内容: +--- -```toml -[supermarket] -base_url = "https://supermarket.memoh.ai" -``` +## 市场内容从哪来 -运维方可以把 `supermarket.base_url` 指向其它可信目录。该 endpoint 会用于连接器列表、Skill 列表、Skill 详情和 Skill 下载。Skills tab 中的 **Registry** 筛选可以只看某一个上游 registry 的结果。 +应用市场的内容来自上游 Registry,默认是 `supermarket.memoh.ai`。自部署实例可以把 `supermarket.base_url` 指向其它可信目录,见 [Server Deploy](../self-hosted/docker.md) 的配置参考。 --- ## 贡献 -新的 Skills 可提交到: +新的应用可提交到: - [felinics/supermarket](https://github.com/felinics/supermarket) diff --git a/docs/zh/guides/use-cases.md b/docs/zh/guides/use-cases.md index 7f3e114..dadc0ba 100644 --- a/docs/zh/guides/use-cases.md +++ b/docs/zh/guides/use-cases.md @@ -1,101 +1,16 @@ -# 使用场景 - -组合多种 Memoh 功能解决实际问题的即用型示例。 - -好的 Bot 分工,是**负责一个可重复的结果**,而不是"大概管一类问题"。下面每个场景都给出:Bot 负责什么、用到哪些功能、以及一句可以直接发给它的起手指令。所有示例都从只读工作开始——先看它做得对不对,再逐步放权。 - -## 晨间简报 - -**它负责:** 每个工作日开始前,把你关心的信息汇成一条消息。 - -**用到:** [定时任务](./schedule.md) · [搜索提供方](../integrations/providers/web-search.md) · [平台](../integrations/channels/index.md) - -**从这句开始:** - -> 每个工作日早上 8 点,汇总我关注的这几个仓库过去 24 小时的 release 和重要 issue,加上今天的天气,整理成一条简报发给我。每条信息注明来源,不确定的内容直接说不确定,不要编造。 - -Bot 自带 `schedule` 工具,你用自然语言说清楚时间,它会自己登记 cron。先用 **Max Calls** 限制试跑几次,确认格式满意再放开。 - -## 发版盯守 - -**它负责:** 盯住一个你在等的外部变化,发生时第一时间主动找你。 - -**用到:** [定时任务](./schedule.md) · [工作区](./container.md) · [平台](../integrations/channels/index.md) - -**从这句开始:** - -> 盯着这个项目的发布页,每 30 分钟检查一次。出了新版本就把变更内容整理成 Markdown 存进工作区,并在 Telegram 上提醒我一句。只做整理,不要执行任何升级或安装。 - -"你不在的时候它也在"是定时任务加主动消息的组合:到点检查、有变化才说话。同类玩法还有盯价格、盯库存、盯文档更新。 - -## 群聊值班助理 - -**它负责:** 在团队群里当值班秘书:被 @ 时答疑,每天固定时间发纪要。 - -**用到:** [平台](../integrations/channels/index.md) · [会话](./sessions.md) · [访问控制](./access.md) · [定时任务](./schedule.md) - -**从这句开始:** - -> 接入这个群之后:有人 @ 你就总结当天讨论要点和待办;每天 18 点主动发一份当日纪要,按"结论 / 待办 / 未决"三段整理。纪要只发在群里,不要私聊任何人。 - -用 [访问控制](./access.md) 的"仅群聊"预设限定它的活动范围。讨论(discuss)会话里 Bot 会自己判断该不该说话,不会刷屏。 - -## 数据表格的日常维护 - -**它负责:** 一份活的数据文件:建表、定期更新、有异动先报告。 - -**用到:** [工作区](./container.md) · [文件](./files.md) · [定时任务](./schedule.md) - -**从这句开始:** - -> 在工作区建一个竞品价格表(CSV)。每天早上检查一次各家官网价格,把变化追加写进表格;有降价先发消息告诉我。只维护这份文件,不要对外发送任何内容给别人。 - -工作区是真实的文件系统加终端(预装 Python、Node.js、uv),清洗 CSV、跑脚本、生成报表都在里面完成,产出物随时可以在 **文件** 里查看。 - -## 带登录墙的网页任务 - -**它负责:** 需要"看着屏幕"的网页操作:后台核对、表单流程、OAuth 授权。 - -**用到:** [Browser / Computer Use](./browser-computer-use.md) · [工作区](./container.md)(可视化桌面) - -**从这句开始:** - -> 打开我们的后台控制台,按我给你的清单逐项核对配置,每一项截图存进工作区。遇到登录、验证码或任何拿不准的画面就停下来等我接管桌面,我处理完你再继续。全程只读,不要修改任何设置。 - -可视化桌面是双向的:你能在桌面面板里看着它操作,也能随时接管键鼠输密码,再把控制权交回去。浏览器会话保留在工作区里,下次任务免登录。 - -## 云端写码与预览 - -**它负责:** 在自己的工作区里写一个小项目,跑起来给你看。 - -**用到:** [Agents / ACP](./acp.md) · [工作区](./container.md) · [技能](./skills.md) - -**从这句开始:** - -> 在工作区里做一个阅读清单网页:能添加、标记读完、按主题筛选。做好后把开发服务跑起来,给我预览方式。所有改动用 git 提交在本地,不要推送到任何远端。 - -习惯用 Claude Code 或 Codex?在 Bot 的 **Agent** 标签页接入你自己的订阅,它会在同一个工作区、同一批文件上继续干活。 - -## 记得住事的个人助理 - -**它负责:** 跨会话、跨平台地记住你的偏好和项目进展,接着上次继续。 - -**用到:** [长期记忆](./memory.md) · [平台](../integrations/channels/index.md) · [定时任务](./schedule.md) - -**从这句开始:** - -> 记住这些偏好:上午留给深度工作,会议尽量约下午;周报每周五下班前要成稿。以后帮我安排提醒和整理摘要时,先查记忆再动手;偏好拿不准就问我,不要猜。 +--- +layout: false +title: Redirecting +--- -配好 [记忆提供方](../integrations/providers/memory/builtin.md) 后,"上次那个 PR 后来怎么样了"这类问题它能直接接住。记忆攒多了用 **Compact** 做一次合并去重。 + -## 从示例到日常使用 + -1. **从只读开始。** 先让它"读并整理",人工检查几次产出,再谈写入和执行。 -2. **把约束写进指令。** 结果、来源、约束、形式、确认点——五件事说清楚(见 [快速开始](./quick-start.md))。 -3. **重复的流程存成 [技能](./skills.md)。** 一句话唤起整套动作,不用每次重打。 -4. **稳定后再上 [定时任务](./schedule.md)。** 先用 Max Calls 试跑,确认无误再放开。 -5. **写入和执行留在审批后面。** 即使流程已经很熟,对外动作也值得多看一眼。 -6. **用 [访问控制](./access.md) 限定谁能使唤它。** 尤其是接入群聊的 Bot。 -7. **让 [记忆](./memory.md) 沉淀偏好。** 纠正过的事不该再错第二次。 +Redirecting to [/zh/use-cases/](/zh/use-cases/). diff --git a/docs/zh/guides/working-with-bots.md b/docs/zh/guides/working-with-bots.md index 810d178..2231b8f 100644 --- a/docs/zh/guides/working-with-bots.md +++ b/docs/zh/guides/working-with-bots.md @@ -10,7 +10,7 @@ - **来源够得着。** 涉及的文件、网站或对话是它真能访问到的:已上传进工作区、已接入的渠道或服务、或者是公开内容。 - **产出好检查。** 你一眼能看出结果对不对,复查的成本才低。 -三条都满足,也还是从只读开始:先让它读和整理,检查几次产出,再逐步放权。[使用场景](./use-cases.md) 里的每个示例都是这么起步的。 +三条都满足,也还是从只读开始:先让它读和整理,检查几次产出,再逐步放权。[使用场景](../use-cases/index.md) 里的每个示例都是这么起步的。 ## 把请求说清楚 @@ -67,7 +67,7 @@ 2. 检查过前几次运行,再考虑放宽。 3. 会离开工作区的动作——给别人发消息、任何对外操作——即使流程已经很熟,也继续留在审批后面。 -这和 [使用场景](./use-cases.md#从示例到日常使用) 的检查清单是同一条路:多批几次请求,远比撤销一次写错便宜。 +这和 [使用场景](../use-cases/index.md#从示例到日常使用) 的检查清单是同一条路:多批几次请求,远比撤销一次写错便宜。 --- @@ -123,7 +123,6 @@ Files、Terminal 以及桌面 / 浏览器面板在聊天的 workspace 区域里 - [模型服务商与模型](../integrations/providers/llm.md) - [内置记忆提供方](../integrations/providers/memory/builtin.md)(如用) - [搜索提供方](../integrations/providers/web-search.md) -- [TTS:Edge](../integrations/providers/tts/edge.md) - [Agents / ACP](./acp.md) --- @@ -145,7 +144,7 @@ Files、Terminal 以及桌面 / 浏览器面板在聊天的 workspace 区域里 注意: - **生图模型** 故意与主聊天模型分开,好单独换「更擅长出图」的。 -- **TTS** 用 [TTS 提供方](../integrations/providers/tts/edge.md) 所配置语音提供方的 `speech` 模型。 +- **TTS** 用 **语音合成** 设置页 所配置语音提供方的 `speech` 模型。 - 所选聊天模型的 `context_window` 会影响会话状态展示和 [会话压缩](./compaction.md)。 --- diff --git a/docs/zh/integrations/index.md b/docs/zh/integrations/index.md index 26d6a90..85fe9e7 100644 --- a/docs/zh/integrations/index.md +++ b/docs/zh/integrations/index.md @@ -15,7 +15,6 @@ - **[LLM 提供方](/zh/integrations/providers/llm)**:配置上游 API、client type 和模型角色。 - **[记忆提供方](/zh/integrations/providers/memory/builtin)**:选择内置记忆、Mem0 或 OpenViking。 -- **[TTS 提供方](/zh/integrations/providers/tts/edge)**:配置语音合成提供方和模型。 - **[搜索提供方](/zh/integrations/providers/web-search)**:配置搜索提供方接入。 ## 产品教程 diff --git a/docs/zh/integrations/providers/llm.md b/docs/zh/integrations/providers/llm.md index 1b90804..e54e182 100644 --- a/docs/zh/integrations/providers/llm.md +++ b/docs/zh/integrations/providers/llm.md @@ -4,7 +4,7 @@ - 一个或多个 **模型服务商**(怎么连上游 API) - 其下的 **模型** -- 若要朗读,再配 **语音合成**(见 [TTS 提供方](./tts/edge.md)) +- 若要朗读,再配 **语音合成**(见 **语音合成** 设置页) - 若要把语音转文字,再配 **语音转写** 聊天与 embedding 在 **Models** 页管理;语音合成模型在 TTS 流程里单走,语音转写模型在 Transcription 设置页管理。 @@ -68,7 +68,7 @@ | `microsoft-speech` | Microsoft 语音合成 | | `google-transcription` | Google 语音转写 | -语音合成与语音转写类型不能当主聊天用。语音合成走 [TTS 提供方](./tts/edge.md),语音转写走 Transcription 设置页。具体模型、音色和语言取决于 provider 模板与上游账号。 +语音合成与语音转写类型不能当主聊天用。语音合成走 **语音合成** 设置页,语音转写走 Transcription 设置页。具体模型、音色和语言取决于 provider 模板与上游账号。 --- @@ -144,7 +144,7 @@ Copilot 凭据以前按用户存,现在和 Codex 一样是模型服务商级 | `speech` | 朗读,挂在 TTS | | `transcription` | 语音转文字,挂在 Transcription | -**Models** 页主要管 chat / embedding;speech 在 [TTS 提供方](./tts/edge.md),transcription 在 Transcription 设置页。 +**Models** 页主要管 chat / embedding;speech 在 **语音合成** 设置页,transcription 在 Transcription 设置页。 --- @@ -202,7 +202,7 @@ Embedding 模型用于语义索引与检索。 ## 语音合成与转写模型 -语音合成在 [TTS 提供方](./tts/edge.md) 配,不跟普通 chat 模型服务商混流。当前语音合成类别包括: +语音合成在 **语音合成** 设置页 配,不跟普通 chat 模型服务商混流。当前语音合成类别包括: - Edge:`edge-speech` - OpenAI 兼容:`openai-speech` @@ -241,5 +241,5 @@ Embedding 模型用于语义索引与检索。 ## 接下来 - 给 Bot 绑聊天、生图、记忆、朗读等:[Bot](../../guides/working-with-bots.md) -- 配语音提供方与语音模型:[TTS 提供方](./tts/edge.md) +- 配语音提供方与语音模型:**语音合成** 设置页 - 配语音转文字:打开客户端的 Transcription 设置页 diff --git a/docs/zh/integrations/providers/memory/mem0.md b/docs/zh/integrations/providers/memory/mem0.md deleted file mode 100644 index 6325c99..0000000 --- a/docs/zh/integrations/providers/memory/mem0.md +++ /dev/null @@ -1,36 +0,0 @@ -# Mem0 记忆 - -把 Bot 接到 [Mem0](https://mem0.ai) 云端,由对方管存储、索引、检索,本机不搭那套库。 - ---- - -## 建提供方 - -1. **Memory Providers** → **Add Memory Provider**。 -2. **Name**、**Provider Type** 选 `mem0`。 -3. **Create**。 - ---- - -## 配置 - -| 字段 | 必填 | 说明 | -|------|------|------| -| **Base URL** | 否 | 空则默认 `https://api.mem0.ai` | -| **API Key** | 是 | 鉴权,按密钥存 | -| **Organization ID** | 否 | 工作区用 | -| **Project ID** | 否 | 工作区用 | - ---- - -## 绑到 Bot - -1. **Bots** → Bot → **General** -2. **Memory Provider** 选 Mem0 -3. 保存 - ---- - -## 使用 - -绑上后,抽取、搜索、管理都走 Mem0 API。日常见 [长期记忆](../../../guides/memory.md)。 diff --git a/docs/zh/integrations/providers/memory/openviking.md b/docs/zh/integrations/providers/memory/openviking.md deleted file mode 100644 index 7e231e8..0000000 --- a/docs/zh/integrations/providers/memory/openviking.md +++ /dev/null @@ -1,34 +0,0 @@ -# OpenViking 记忆 - -可自建或接 SaaS 的独立记忆 API,给需要专用记忆后端的场景多一个选项。 - ---- - -## 建提供方 - -1. **Memory Providers** → **Add Memory Provider**。 -2. **Name**、**Provider Type** 选 `openviking`。 -3. **Create**。 - ---- - -## 配置 - -| 字段 | 必填 | 说明 | -|------|------|------| -| **Base URL** | 是 | 如 `http://openviking:8088` | -| **API Key** | 否 | 需要时填,按密钥存 | - ---- - -## 绑到 Bot - -1. **Bots** → Bot → **General** -2. **Memory Provider** 选 OpenViking -3. 保存 - ---- - -## 使用 - -绑上后,记忆相关 API 都走 OpenViking。日常见 [长期记忆](../../../guides/memory.md)。 diff --git a/docs/zh/integrations/providers/tts/edge.md b/docs/zh/integrations/providers/tts/edge.md deleted file mode 100644 index 460376a..0000000 --- a/docs/zh/integrations/providers/tts/edge.md +++ /dev/null @@ -1,40 +0,0 @@ -# Edge TTS - -用 Edge 对外公开的朗读接口做合成:免费、无 API key,提供 256+ 个声音,覆盖 50+ 种语言。 - ---- - -## 建提供方 - -1. **TTS Providers** → **Add**。 -2. 类型选 `edge`。 -3. **Create**。 - -创建提供方时会自动导入默认模型 `edge-read-aloud`。 - ---- - -## 调模型 - -点 `edge-read-aloud`: - -| 字段 | 说明 | -|------|------| -| **Voice** | 语言 + 声线 id,默认 `en-US-EmmaMultilingualNeural`;共 256+ 个声音、50+ 种语言可选 | -| **Format** | 输出格式:`audio-24khz-48kbitrate-mono-mp3`(默认)、`audio-24khz-96kbitrate-mono-mp3`、`webm-24khz-16bit-mono-opus` | -| **Speed** | 语速:`0.5`、`1.0`(默认)、`2.0`、`3.0` | -| **Pitch** | 音高:`-100` ~ `+100`,默认 `0` | - ---- - -## 绑到 Bot - -1. Bot **General** → **TTS Model** -2. 选配好的 Edge 模型 -3. 保存 - ---- - -## 试听 - -模型配置页有内置的试合成按钮,绑给 Bot 前先听一遍所选声音、格式、语速、音高的效果。 diff --git a/docs/zh/memory-providers/mem0.md b/docs/zh/memory-providers/mem0.md deleted file mode 100644 index 6a18a4a..0000000 --- a/docs/zh/memory-providers/mem0.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: false -title: Redirecting ---- - - - - - -Redirecting to [/zh/integrations/providers/memory/mem0](/zh/integrations/providers/memory/mem0). diff --git a/docs/zh/memory-providers/openviking.md b/docs/zh/memory-providers/openviking.md deleted file mode 100644 index c0a65dc..0000000 --- a/docs/zh/memory-providers/openviking.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: false -title: Redirecting ---- - - - - - -Redirecting to [/zh/integrations/providers/memory/openviking](/zh/integrations/providers/memory/openviking). diff --git a/docs/zh/self-hosted/connectors.md b/docs/zh/self-hosted/connectors.md new file mode 100644 index 0000000..dee73ba --- /dev/null +++ b/docs/zh/self-hosted/connectors.md @@ -0,0 +1,56 @@ +# 连接器(Connect-It) + +连接器让 Bot 能用上第三方服务(GitHub、Notion 这类)的工具。背后接的是 [Connect-It](https://github.com/memohai/connect-it),一个和 Memoh 一起部署的配套服务。所有凭据(OAuth token、API Key)都存在 Connect-It 那边;Memoh 只存一张绑定表——哪个 Bot 绑了哪个连接、工具命名空间叫什么、开没开。 + +对使用者来说,连接器不是单独安装的东西:它作为[应用](../guides/supermarket.md)的组件随 App 一起到达。App 的清单里声明了它用到哪些连接器类型、是否必需;装好后在 Bot 的 **应用** 标签页里完成授权即可。本页其余部分是部署方视角——怎么把 Connect-It 跑起来,以及连接背后的机制。 + +--- + +## 服务端前提 + +服务端配置了 Connect-It 地址,连接器功能才会出现: + +```toml +[connect_it] +base_url = "" # 例如 "http://connect-it:8421" +api_token = "" # 服务端之间的可信 token +``` + +两项留空即关闭该功能。线上环境建议用对应的环境变量(`MEMOH_CONNECT_IT_BASE_URL`、`MEMOH_CONNECT_IT_API_TOKEN`)。 + +一键 Server Deploy 会在全新安装时自动带起一个同机部署的 Connect-It,见 [Server Deploy](./docker.md#connect-it-连接器)。没配置 Connect-It 时,依赖连接器的 App 组件会显示"连接器不可用"。 + +--- + +## 授权与管理 + +装好带连接器的 App 后,Bot 的 **应用** 标签页会按组件列出它的连接器,并标注状态:**需要授权**、**可选**,或 **所有工作区共享**。点 **去授权** 完成绑定——OAuth 走弹窗授权(浏览器拦了弹窗就放行后重试),API Key 则填好凭据字段。 + +每条连接会显示状态: + +| 状态 | 含义 | +|------|------| +| **已连接** | 正常,工具对 Bot 可用 | +| **等待授权** | 连接建了但 OAuth 没走完;补完授权,或者断开它 | +| **需要重新授权** | 凭据过期或被撤销,点 **重新授权** | +| **授权失败** | 上次授权没成功,可再点 **重新授权** 重试 | +| **不可用** | 这个连接器类型在当前 Connect-It 侧没有提供 | +| **已停用** | 已停用,工具不会给到 Bot | + +可以**启用 / 停用**某条连接而不删掉它;**断开连接**则把绑定从 Bot 上移除,**并且**删掉 Connect-It 里存的这条连接(含凭据)——之后使用它的 App 需要重新授权。 + +--- + +## 工具怎么到 Bot 手上 + +对话时,Memoh 会把这个 Bot 所有启用且状态正常的连接聚合成一个 MCP 会话,作为工具源给智能体。连接器工具和 workspace、MCP 工具并排出现。 + +每条连接在绑定那一刻会拿到一个按连接器类型生成的**工具命名空间**——GitHub 连接是 `github`,再连一个就是 `github-2`。命名空间在绑定的整个生命周期内固定不变:之后增删其它连接,不会影响已有连接的工具名。 + +--- + +## 相关页面 + +- [应用市场](../guides/supermarket.md) —— 应用(含连接器组件)的安装入口。 +- [MCP](../guides/mcp.md) —— 直接管理 MCP 连接。 +- [Server Deploy](./docker.md#connect-it-连接器) —— 同机部署 Connect-It、凭据管理和 OAuth 回调地址。 diff --git a/docs/zh/self-hosted/docker.md b/docs/zh/self-hosted/docker.md index e822a90..e16aaf8 100644 --- a/docs/zh/self-hosted/docker.md +++ b/docs/zh/self-hosted/docker.md @@ -21,12 +21,12 @@ Compose 里有多组服务。有的默认就起,有的通过 `--profile` 打 | **pgvector** | *(核心)* | 带 `pgvector` 的 PostgreSQL,供可选的记忆向量使用;见 [内置记忆](../integrations/providers/memory/builtin.md) | | **migrate** | *(核心,一次性)* | 在主服务启动前执行 `memoh-server migrate up` | | **webhook-tunnel** | `webhook-tunnel` | 可选的 `cloudflared` 快速隧道,把渠道 worker 的 webhook 监听暴露到公网 | -| **connect-it** | `connectors` | 同机部署的 [Connect-It](https://github.com/memohai/connect-it),支撑 Bot [连接器](../guides/connectors.md)(见下) | +| **connect-it** | `connectors` | 同机部署的 [Connect-It](https://github.com/memohai/connect-it),支撑 Bot [连接器](./connectors.md)(见下) | ### Connect-It 连接器 -**connect-it** 容器跑的是 [Connect-It](https://github.com/memohai/connect-it),Bot [连接器](../guides/connectors.md)背后的服务——通过 OAuth 或 API Key 把第三方服务(GitHub、Notion 这类)连给 Bot。它共用 Memoh 的 PostgreSQL,数据隔离在单独的 `connect_it` schema 里,迁移自己管。 +**connect-it** 容器跑的是 [Connect-It](https://github.com/memohai/connect-it),Bot [连接器](./connectors.md)背后的服务——通过 OAuth 或 API Key 把第三方服务(GitHub、Notion 这类)连给 Bot。它共用 Memoh 的 PostgreSQL,数据隔离在单独的 `connect_it` schema 里,迁移自己管。 安装脚本把 Connect-It 全程管起来: @@ -147,7 +147,7 @@ POSTGRES_PASSWORD=你的库密码 docker compose up -d > **重要**:`docker-compose.yml` 默认挂 `./config.toml`,先建好文件再 `up`,否则起不来。 -手动部署要开[连接器](../guides/connectors.md)的话,自己生成 Connect-It 凭据并加 `connectors` profile: +手动部署要开[连接器](./connectors.md)的话,自己生成 Connect-It 凭据并加 `connectors` profile: ```bash MEMOH_CONNECT_IT_BASE_URL="http://connect-it:8421" \ @@ -212,7 +212,7 @@ docker compose -f docker-compose.yml -f docker/docker-compose.cn.yml up -d | `[internal_rpc]` | 主服务/渠道 worker 拆分部署的 RPC 地址与共享密钥 | | `[webhook_tunnel]` | webhook 隧道模式(`disabled` 或 `external`)与 `public_base_url` | | `[registry]` | 模型服务商定义目录 | -| `[connect_it]` | [连接器](../guides/connectors.md)用的 Connect-It 地址(`base_url`、`api_token`);两项都空即关闭该功能。Compose 环境里由 `MEMOH_CONNECT_IT_BASE_URL` / `MEMOH_CONNECT_IT_API_TOKEN` 覆盖 | +| `[connect_it]` | [连接器](./connectors.md)用的 Connect-It 地址(`base_url`、`api_token`);两项都空即关闭该功能。Compose 环境里由 `MEMOH_CONNECT_IT_BASE_URL` / `MEMOH_CONNECT_IT_API_TOKEN` 覆盖 | | `[web]` | 前端 host/port | | `[agent]` | 工具输出截断上限:`tool_output_max_bytes`(默认 65536)、`tool_output_max_lines`(默认 2000)、`system_files_max_bytes`(默认 32768)。超限时保留头尾,不是盲切。 | | `[session_runtime]` | 多实例部署的会话状态后端,见下方[多实例部署](#多实例部署) | diff --git a/docs/zh/self-hosted/workspace-backends.md b/docs/zh/self-hosted/workspace-backends.md index 3473b6c..b52f7df 100644 --- a/docs/zh/self-hosted/workspace-backends.md +++ b/docs/zh/self-hosted/workspace-backends.md @@ -109,3 +109,31 @@ Bot 网络有两层: | `local` | 宿主机网络 | 不支持 | 宿主机级别 | 无容器桌面 | Overlay provider 在 Bot 界面里配置,不在全局 TOML 里配。全局 backend 仍然重要,因为它决定能跑哪类 overlay driver。 + +## CDI 设备(GPU 透传) + +要把宿主机设备通过 **CDI**(最常见是 GPU)透进容器型 workspace,在该 Bot 的 **工作区** → **Advanced** 里配置。一般只有确实要在工作区里跑 CUDA/ROCm 等才要动。 + +### 配法 + +1. 打开 **工作区** 标签页;没有容器先 **创建**。 +2. 展开 **Advanced**,开 **GPU**,在 **CDI devices** 里写设备名,每行一个或逗号分隔: + - `nvidia.com/gpu=0`、`nvidia.com/gpu=all` + - `amd.com/gpu=0`、`amd.com/gpu=all` + +### 宿主要求 + +宿主机上驱动、厂商工具、CDI spec 要已就绪,通常意味着: + +- 宿主机上 GPU 本来就能用 +- `/etc/cdi` 或 `/var/run/cdi` 里有 spec +- 你填的名字和运行时看见的一致(NVIDIA 用 `nvidia-ctk cdi list` 查,AMD 用 `amd-ctk cdi list`) + +若报 `unresolvable CDI devices`,多半是名字对不上。 + +### 注意 + +- CDI 在**创建**时生效:改配置后通常要**重建**容器,只停再起**不会**换已挂设备。 +- 镜像里仍要装对的用户态库和工具,才能真正跑 CUDA/ROCm 软件。 +- 建好后 **工作区** 标签页会显示当前挂上的设备,便于核对。 +- 后端支持情况见上表——只有 `containerd` 支持 CDI。 diff --git a/docs/zh/tts-providers/edge.md b/docs/zh/tts-providers/edge.md deleted file mode 100644 index fedcd9c..0000000 --- a/docs/zh/tts-providers/edge.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: false -title: Redirecting ---- - - - - - -Redirecting to [/zh/integrations/providers/tts/edge](/zh/integrations/providers/tts/edge). diff --git a/docs/zh/tts-providers/index.md b/docs/zh/tts-providers/index.md deleted file mode 100644 index fedcd9c..0000000 --- a/docs/zh/tts-providers/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: false -title: Redirecting ---- - - - - - -Redirecting to [/zh/integrations/providers/tts/edge](/zh/integrations/providers/tts/edge). diff --git a/docs/zh/use-cases/code-and-preview.md b/docs/zh/use-cases/code-and-preview.md new file mode 100644 index 0000000..b8f94af --- /dev/null +++ b/docs/zh/use-cases/code-and-preview.md @@ -0,0 +1,17 @@ +# 云端写码与预览 + +**它负责:** 在自己的工作区里写一个小项目,跑起来给你看。 + +**用到:** [Agents / ACP](../guides/acp.md) · [工作区](../guides/container.md) · [技能](../guides/skills.md) + + + +## 从这句开始 + +> 在工作区里做一个阅读清单网页:能添加、标记读完、按主题筛选。做好后把开发服务跑起来,给我预览方式。所有改动用 git 提交在本地,不要推送到任何远端。 + +## 它是怎么跑起来的 + +习惯用 Claude Code 或 Codex?在 Bot 的 **Agent** 标签页接入你自己的订阅,它会在同一个工作区、同一批文件上继续干活。 + + diff --git a/docs/zh/use-cases/data-upkeep.md b/docs/zh/use-cases/data-upkeep.md new file mode 100644 index 0000000..3a81b9f --- /dev/null +++ b/docs/zh/use-cases/data-upkeep.md @@ -0,0 +1,17 @@ +# 数据表格的日常维护 + +**它负责:** 一份活的数据文件:建表、定期更新、有异动先报告。 + +**用到:** [工作区](../guides/container.md) · [文件](../guides/files.md) · [定时任务](../guides/schedule.md) + + + +## 从这句开始 + +> 在工作区建一个竞品价格表(CSV)。每天早上检查一次各家官网价格,把变化追加写进表格;有降价先发消息告诉我。只维护这份文件,不要对外发送任何内容给别人。 + +## 它是怎么跑起来的 + +工作区是真实的文件系统加终端(预装 Python、Node.js、uv),清洗 CSV、跑脚本、生成报表都在里面完成,产出物随时可以在 **文件** 里查看。 + + diff --git a/docs/zh/use-cases/gated-web-tasks.md b/docs/zh/use-cases/gated-web-tasks.md new file mode 100644 index 0000000..1fae3fb --- /dev/null +++ b/docs/zh/use-cases/gated-web-tasks.md @@ -0,0 +1,17 @@ +# 带登录墙的网页任务 + +**它负责:** 需要"看着屏幕"的网页操作:后台核对、表单流程、OAuth 授权。 + +**用到:** [Browser / Computer Use](../guides/browser-computer-use.md) · [工作区](../guides/container.md)(可视化桌面) + + + +## 从这句开始 + +> 打开我们的后台控制台,按我给你的清单逐项核对配置,每一项截图存进工作区。遇到登录、验证码或任何拿不准的画面就停下来等我接管桌面,我处理完你再继续。全程只读,不要修改任何设置。 + +## 它是怎么跑起来的 + +可视化桌面是双向的:你能在桌面面板里看着它操作,也能随时接管键鼠输密码,再把控制权交回去。浏览器会话保留在工作区里,下次任务免登录。 + + diff --git a/docs/zh/use-cases/group-duty-assistant.md b/docs/zh/use-cases/group-duty-assistant.md new file mode 100644 index 0000000..2341687 --- /dev/null +++ b/docs/zh/use-cases/group-duty-assistant.md @@ -0,0 +1,17 @@ +# 群聊值班助理 + +**它负责:** 在团队群里当值班秘书:被 @ 时答疑,每天固定时间发纪要。 + +**用到:** [平台](../integrations/channels/index.md) · [会话](../guides/sessions.md) · [访问控制](../guides/access.md) · [定时任务](../guides/schedule.md) + + + +## 从这句开始 + +> 接入这个群之后:有人 @ 你就总结当天讨论要点和待办;每天 18 点主动发一份当日纪要,按"结论 / 待办 / 未决"三段整理。纪要只发在群里,不要私聊任何人。 + +## 它是怎么跑起来的 + +用[访问控制](../guides/access.md)的"仅群聊"预设限定它的活动范围。讨论(discuss)会话里 Bot 会自己判断该不该说话,不会刷屏。 + + diff --git a/docs/zh/use-cases/index.md b/docs/zh/use-cases/index.md new file mode 100644 index 0000000..ed81b7e --- /dev/null +++ b/docs/zh/use-cases/index.md @@ -0,0 +1,25 @@ +# 使用场景 + +组合多种 Memoh 功能解决实际问题的即用型示例。每个场景独立成章:Bot 负责什么、用到哪些功能、怎么一步步搭起来。 + +好的 Bot 分工,是**负责一个可重复的结果**,而不是"大概管一类问题"。所有示例都从只读工作开始——先看它做得对不对,再逐步放权。 + +| 场景 | 它负责 | +|------|--------| +| [晨间简报](./morning-briefing.md) | 每个工作日开始前,把你关心的信息汇成一条消息 | +| [发版盯守](./release-watch.md) | 盯住一个你在等的外部变化,发生时第一时间找你 | +| [群聊值班助理](./group-duty-assistant.md) | 在团队群里答疑、发每日纪要 | +| [数据表格的日常维护](./data-upkeep.md) | 一份活的数据文件:建表、定期更新、异动先报告 | +| [带登录墙的网页任务](./gated-web-tasks.md) | 需要"看着屏幕"的网页操作:核对、表单、授权 | +| [云端写码与预览](./code-and-preview.md) | 在自己的工作区里写小项目,跑起来给你看 | +| [记得住事的个人助理](./personal-assistant.md) | 跨会话、跨平台记住你的偏好和项目进展 | + +## 从示例到日常使用 + +1. **从只读开始。** 先让它"读并整理",人工检查几次产出,再谈写入和执行。 +2. **把约束写进指令。** 结果、来源、约束、形式、确认点——五件事说清楚(见[快速开始](../guides/quick-start.md))。 +3. **重复的流程存成[技能](../guides/skills.md)。** 一句话唤起整套动作,不用每次重打。 +4. **稳定后再上[定时任务](../guides/schedule.md)。** 先用 Max Calls 试跑,确认无误再放开。 +5. **写入和执行留在审批后面。** 即使流程已经很熟,对外动作也值得多看一眼。 +6. **用[访问控制](../guides/access.md)限定谁能使唤它。** 尤其是接入群聊的 Bot。 +7. **让[记忆](../guides/memory.md)沉淀偏好。** 纠正过的事不该再错第二次。 diff --git a/docs/zh/use-cases/morning-briefing.md b/docs/zh/use-cases/morning-briefing.md new file mode 100644 index 0000000..c0f4604 --- /dev/null +++ b/docs/zh/use-cases/morning-briefing.md @@ -0,0 +1,17 @@ +# 晨间简报 + +**它负责:** 每个工作日开始前,把你关心的信息汇成一条消息。 + +**用到:** [定时任务](../guides/schedule.md) · [搜索提供方](../integrations/providers/web-search.md) · [平台](../integrations/channels/index.md) + + + +## 从这句开始 + +> 每个工作日早上 8 点,汇总我关注的这几个仓库过去 24 小时的 release 和重要 issue,加上今天的天气,整理成一条简报发给我。每条信息注明来源,不确定的内容直接说不确定,不要编造。 + +## 它是怎么跑起来的 + +Bot 自带 `schedule` 工具,你用自然语言说清楚时间,它会自己登记 cron。先用 **Max Calls** 限制试跑几次,确认格式满意再放开。 + + diff --git a/docs/zh/use-cases/personal-assistant.md b/docs/zh/use-cases/personal-assistant.md new file mode 100644 index 0000000..af63ff0 --- /dev/null +++ b/docs/zh/use-cases/personal-assistant.md @@ -0,0 +1,17 @@ +# 记得住事的个人助理 + +**它负责:** 跨会话、跨平台地记住你的偏好和项目进展,接着上次继续。 + +**用到:** [长期记忆](../guides/memory.md) · [平台](../integrations/channels/index.md) · [定时任务](../guides/schedule.md) + + + +## 从这句开始 + +> 记住这些偏好:上午留给深度工作,会议尽量约下午;周报每周五下班前要成稿。以后帮我安排提醒和整理摘要时,先查记忆再动手;偏好拿不准就问我,不要猜。 + +## 它是怎么跑起来的 + +配好[记忆提供方](../integrations/providers/memory/builtin.md)后,"上次那个 PR 后来怎么样了"这类问题它能直接接住。记忆攒多了用 **Compact** 做一次合并去重。 + + diff --git a/docs/zh/use-cases/release-watch.md b/docs/zh/use-cases/release-watch.md new file mode 100644 index 0000000..5d906e0 --- /dev/null +++ b/docs/zh/use-cases/release-watch.md @@ -0,0 +1,17 @@ +# 发版盯守 + +**它负责:** 盯住一个你在等的外部变化,发生时第一时间主动找你。 + +**用到:** [定时任务](../guides/schedule.md) · [工作区](../guides/container.md) · [平台](../integrations/channels/index.md) + + + +## 从这句开始 + +> 盯着这个项目的发布页,每 30 分钟检查一次。出了新版本就把变更内容整理成 Markdown 存进工作区,并在 Telegram 上提醒我一句。只做整理,不要执行任何升级或安装。 + +## 它是怎么跑起来的 + +"你不在的时候它也在"是定时任务加主动消息的组合:到点检查、有变化才说话。同类玩法还有盯价格、盯库存、盯文档更新。 + + From 6484fd3ec01c5e1cd561e1f19464cb3f40ee93b8 Mon Sep 17 00:00:00 2001 From: Yanbo Wang Date: Tue, 6 Oct 2026 01:50:39 +0800 Subject: [PATCH 2/2] docs: drop Use Cases, add Japanese and Russian locales MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Use Cases removed entirely (en+zh pages, nav entry, sidebar group, redirect stubs, DocsHome card, every inbound mention) pending human-written chapters with real screenshots; the home card slot now points at Deployment - Japanese locale: full ja translation of all 80 pages with its own nav, sidebar, and DocsHome copy; terminology bound to the product's ja.json UI strings; legacy redirect stubs generated for /ja - Russian locale: full ru translation of all 80 pages; the product has no Russian UI, so bold UI labels stay as the English product strings (rule recorded in CONTRIBUTING) - Both new locales proofread page-by-page against the en (facts) and zh (tone) sources by independent review passes; fixes included NFKD anchor-slug corrections (decomposed kana, й→и / ё→е) validated against the installed VitePress slugifier - check-locale-parity.mjs generalized to en/zh/ja/ru (80 pages / 39 sidebar links per locale); CI job renamed accordingly; README and CONTRIBUTING updated to the four-locale workflow - zh fact fix: acp.md said three built-in agent profiles, en/product say two Co-Authored-By: Claude Fable 5 --- .github/workflows/docs-parity.yml | 2 +- CONTRIBUTING.md | 20 +- README.md | 23 +- README_CN.md | 21 +- docs/.vitepress/config.ts | 26 +- docs/.vitepress/en.ts | 14 - docs/.vitepress/ja.ts | 73 ++++ docs/.vitepress/ru.ts | 73 ++++ docs/.vitepress/theme/components/DocsHome.vue | 88 +++- docs/.vitepress/zh.ts | 14 - docs/guides/index.md | 1 - docs/guides/overview.md | 3 +- docs/guides/quick-start.md | 1 - docs/guides/use-cases.md | 16 - docs/guides/working-with-bots.md | 4 +- docs/ja/about.md | 44 ++ docs/ja/channels/dingtalk.md | 16 + docs/ja/channels/discord.md | 16 + docs/ja/channels/feishu.md | 16 + docs/ja/channels/index.md | 16 + docs/ja/channels/qq.md | 16 + docs/ja/channels/slack.md | 16 + docs/ja/channels/telegram.md | 16 + docs/ja/channels/wecom.md | 16 + docs/ja/channels/weixin.md | 16 + docs/ja/getting-started/access.md | 16 + docs/ja/getting-started/acp.md | 16 + docs/ja/getting-started/bot.md | 16 + .../getting-started/browser-computer-use.md | 16 + docs/ja/getting-started/channels.md | 16 + docs/ja/getting-started/compaction.md | 16 + docs/ja/getting-started/container.md | 16 + docs/ja/getting-started/files.md | 16 + docs/ja/getting-started/heartbeat.md | 16 + docs/ja/getting-started/mcp.md | 16 + docs/ja/getting-started/memory.md | 16 + docs/ja/getting-started/plugins.md | 16 + docs/ja/getting-started/provider-and-model.md | 16 + docs/ja/getting-started/schedule.md | 16 + docs/ja/getting-started/search-provider.md | 16 + docs/ja/getting-started/sessions.md | 16 + docs/ja/getting-started/skills.md | 16 + docs/ja/getting-started/slash-commands.md | 16 + docs/ja/getting-started/supermarket.md | 16 + docs/ja/guides/access.md | 236 +++++++++++ docs/ja/guides/acp.md | 82 ++++ docs/ja/guides/approvals.md | 50 +++ docs/ja/guides/bot.md | 16 + docs/ja/guides/browser-computer-use.md | 53 +++ docs/ja/guides/compaction.md | 115 +++++ docs/ja/guides/container.md | 58 +++ docs/ja/guides/extensions.md | 37 ++ docs/ja/guides/files.md | 36 ++ docs/ja/guides/get-started.md | 16 + docs/ja/guides/hooks.md | 271 ++++++++++++ docs/ja/guides/index.md | 40 ++ docs/ja/guides/mcp.md | 68 +++ docs/ja/guides/memory.md | 86 ++++ docs/ja/guides/overview.md | 56 +++ docs/ja/guides/quick-start.md | 126 ++++++ docs/ja/guides/schedule.md | 86 ++++ docs/ja/guides/sessions.md | 106 +++++ docs/ja/guides/skills.md | 53 +++ docs/ja/guides/slash-commands.md | 313 ++++++++++++++ docs/ja/guides/supermarket.md | 44 ++ docs/ja/guides/working-with-bots.md | 189 +++++++++ docs/ja/index.md | 10 + docs/ja/installation/desktop.md | 16 + docs/ja/installation/docker.md | 16 + docs/ja/installation/index.md | 16 + docs/ja/installation/kata-containerd.md | 16 + docs/ja/installation/sqlite.md | 16 + docs/ja/installation/workspace-backends.md | 16 + docs/ja/integrations/channels/dingtalk.md | 53 +++ docs/ja/integrations/channels/discord.md | 59 +++ docs/ja/integrations/channels/feishu.md | 90 ++++ docs/ja/integrations/channels/index.md | 26 ++ docs/ja/integrations/channels/line.md | 79 ++++ docs/ja/integrations/channels/qq.md | 61 +++ docs/ja/integrations/channels/slack.md | 116 +++++ docs/ja/integrations/channels/telegram.md | 46 ++ docs/ja/integrations/channels/wecom.md | 51 +++ docs/ja/integrations/channels/weixin.md | 52 +++ docs/ja/integrations/index.md | 22 + docs/ja/integrations/providers/llm.md | 245 +++++++++++ .../integrations/providers/memory/builtin.md | 90 ++++ docs/ja/integrations/providers/video.md | 58 +++ docs/ja/integrations/providers/web-search.md | 48 +++ docs/ja/memory-providers/builtin.md | 16 + docs/ja/memory-providers/index.md | 16 + docs/ja/self-hosted/connectors.md | 56 +++ docs/ja/self-hosted/desktop.md | 47 ++ docs/ja/self-hosted/docker.md | 277 ++++++++++++ docs/ja/self-hosted/index.md | 23 + docs/ja/self-hosted/workspace-backends.md | 139 ++++++ docs/ru/about.md | 44 ++ docs/ru/channels/dingtalk.md | 16 + docs/ru/channels/discord.md | 16 + docs/ru/channels/feishu.md | 16 + docs/ru/channels/index.md | 16 + docs/ru/channels/qq.md | 16 + docs/ru/channels/slack.md | 16 + docs/ru/channels/telegram.md | 16 + docs/ru/channels/wecom.md | 16 + docs/ru/channels/weixin.md | 16 + docs/ru/getting-started/access.md | 16 + docs/ru/getting-started/acp.md | 16 + docs/ru/getting-started/bot.md | 16 + .../getting-started/browser-computer-use.md | 16 + docs/ru/getting-started/channels.md | 16 + docs/ru/getting-started/compaction.md | 16 + docs/ru/getting-started/container.md | 16 + docs/ru/getting-started/files.md | 16 + docs/ru/getting-started/heartbeat.md | 16 + docs/ru/getting-started/mcp.md | 16 + docs/ru/getting-started/memory.md | 16 + docs/ru/getting-started/plugins.md | 16 + docs/ru/getting-started/provider-and-model.md | 16 + docs/ru/getting-started/schedule.md | 16 + docs/ru/getting-started/search-provider.md | 16 + docs/ru/getting-started/sessions.md | 16 + docs/ru/getting-started/skills.md | 16 + docs/ru/getting-started/slash-commands.md | 16 + docs/ru/getting-started/supermarket.md | 16 + docs/ru/guides/access.md | 236 +++++++++++ docs/ru/guides/acp.md | 82 ++++ docs/ru/guides/approvals.md | 50 +++ docs/ru/guides/bot.md | 16 + docs/ru/guides/browser-computer-use.md | 53 +++ docs/ru/guides/compaction.md | 137 ++++++ docs/ru/guides/container.md | 58 +++ docs/ru/guides/extensions.md | 37 ++ docs/ru/guides/files.md | 46 ++ docs/ru/guides/get-started.md | 16 + docs/ru/guides/hooks.md | 271 ++++++++++++ docs/ru/guides/index.md | 40 ++ docs/ru/guides/mcp.md | 85 ++++ docs/ru/guides/memory.md | 114 +++++ docs/ru/guides/overview.md | 56 +++ docs/ru/guides/quick-start.md | 126 ++++++ docs/ru/guides/schedule.md | 102 +++++ docs/ru/guides/sessions.md | 142 +++++++ docs/ru/guides/skills.md | 53 +++ docs/ru/guides/slash-commands.md | 400 ++++++++++++++++++ docs/ru/guides/supermarket.md | 44 ++ docs/ru/guides/working-with-bots.md | 216 ++++++++++ docs/ru/index.md | 10 + docs/ru/installation/desktop.md | 16 + docs/ru/installation/docker.md | 16 + docs/ru/installation/index.md | 16 + docs/ru/installation/kata-containerd.md | 16 + docs/ru/installation/sqlite.md | 16 + docs/ru/installation/workspace-backends.md | 16 + docs/ru/integrations/channels/dingtalk.md | 53 +++ docs/ru/integrations/channels/discord.md | 59 +++ docs/ru/integrations/channels/feishu.md | 90 ++++ docs/ru/integrations/channels/index.md | 26 ++ docs/ru/integrations/channels/line.md | 79 ++++ docs/ru/integrations/channels/qq.md | 61 +++ docs/ru/integrations/channels/slack.md | 116 +++++ docs/ru/integrations/channels/telegram.md | 46 ++ docs/ru/integrations/channels/wecom.md | 51 +++ docs/ru/integrations/channels/weixin.md | 52 +++ docs/ru/integrations/index.md | 22 + docs/ru/integrations/providers/llm.md | 261 ++++++++++++ .../integrations/providers/memory/builtin.md | 99 +++++ docs/ru/integrations/providers/video.md | 58 +++ docs/ru/integrations/providers/web-search.md | 58 +++ docs/ru/memory-providers/builtin.md | 16 + docs/ru/memory-providers/index.md | 16 + docs/ru/self-hosted/connectors.md | 56 +++ docs/ru/self-hosted/desktop.md | 47 ++ docs/ru/self-hosted/docker.md | 301 +++++++++++++ docs/ru/self-hosted/index.md | 23 + docs/ru/self-hosted/workspace-backends.md | 139 ++++++ docs/use-cases/code-and-preview.md | 17 - docs/use-cases/data-upkeep.md | 17 - docs/use-cases/gated-web-tasks.md | 17 - docs/use-cases/group-duty-assistant.md | 17 - docs/use-cases/index.md | 25 -- docs/use-cases/morning-briefing.md | 17 - docs/use-cases/personal-assistant.md | 17 - docs/use-cases/release-watch.md | 17 - docs/zh/guides/acp.md | 2 +- docs/zh/guides/index.md | 1 - docs/zh/guides/overview.md | 3 +- docs/zh/guides/quick-start.md | 1 - docs/zh/guides/use-cases.md | 16 - docs/zh/guides/working-with-bots.md | 4 +- docs/zh/use-cases/code-and-preview.md | 17 - docs/zh/use-cases/data-upkeep.md | 17 - docs/zh/use-cases/gated-web-tasks.md | 17 - docs/zh/use-cases/group-duty-assistant.md | 17 - docs/zh/use-cases/index.md | 25 -- docs/zh/use-cases/morning-briefing.md | 17 - docs/zh/use-cases/personal-assistant.md | 17 - docs/zh/use-cases/release-watch.md | 17 - scripts/check-locale-parity.mjs | 131 +++--- 198 files changed, 9472 insertions(+), 465 deletions(-) create mode 100644 docs/.vitepress/ja.ts create mode 100644 docs/.vitepress/ru.ts delete mode 100644 docs/guides/use-cases.md create mode 100644 docs/ja/about.md create mode 100644 docs/ja/channels/dingtalk.md create mode 100644 docs/ja/channels/discord.md create mode 100644 docs/ja/channels/feishu.md create mode 100644 docs/ja/channels/index.md create mode 100644 docs/ja/channels/qq.md create mode 100644 docs/ja/channels/slack.md create mode 100644 docs/ja/channels/telegram.md create mode 100644 docs/ja/channels/wecom.md create mode 100644 docs/ja/channels/weixin.md create mode 100644 docs/ja/getting-started/access.md create mode 100644 docs/ja/getting-started/acp.md create mode 100644 docs/ja/getting-started/bot.md create mode 100644 docs/ja/getting-started/browser-computer-use.md create mode 100644 docs/ja/getting-started/channels.md create mode 100644 docs/ja/getting-started/compaction.md create mode 100644 docs/ja/getting-started/container.md create mode 100644 docs/ja/getting-started/files.md create mode 100644 docs/ja/getting-started/heartbeat.md create mode 100644 docs/ja/getting-started/mcp.md create mode 100644 docs/ja/getting-started/memory.md create mode 100644 docs/ja/getting-started/plugins.md create mode 100644 docs/ja/getting-started/provider-and-model.md create mode 100644 docs/ja/getting-started/schedule.md create mode 100644 docs/ja/getting-started/search-provider.md create mode 100644 docs/ja/getting-started/sessions.md create mode 100644 docs/ja/getting-started/skills.md create mode 100644 docs/ja/getting-started/slash-commands.md create mode 100644 docs/ja/getting-started/supermarket.md create mode 100644 docs/ja/guides/access.md create mode 100644 docs/ja/guides/acp.md create mode 100644 docs/ja/guides/approvals.md create mode 100644 docs/ja/guides/bot.md create mode 100644 docs/ja/guides/browser-computer-use.md create mode 100644 docs/ja/guides/compaction.md create mode 100644 docs/ja/guides/container.md create mode 100644 docs/ja/guides/extensions.md create mode 100644 docs/ja/guides/files.md create mode 100644 docs/ja/guides/get-started.md create mode 100644 docs/ja/guides/hooks.md create mode 100644 docs/ja/guides/index.md create mode 100644 docs/ja/guides/mcp.md create mode 100644 docs/ja/guides/memory.md create mode 100644 docs/ja/guides/overview.md create mode 100644 docs/ja/guides/quick-start.md create mode 100644 docs/ja/guides/schedule.md create mode 100644 docs/ja/guides/sessions.md create mode 100644 docs/ja/guides/skills.md create mode 100644 docs/ja/guides/slash-commands.md create mode 100644 docs/ja/guides/supermarket.md create mode 100644 docs/ja/guides/working-with-bots.md create mode 100644 docs/ja/index.md create mode 100644 docs/ja/installation/desktop.md create mode 100644 docs/ja/installation/docker.md create mode 100644 docs/ja/installation/index.md create mode 100644 docs/ja/installation/kata-containerd.md create mode 100644 docs/ja/installation/sqlite.md create mode 100644 docs/ja/installation/workspace-backends.md create mode 100644 docs/ja/integrations/channels/dingtalk.md create mode 100644 docs/ja/integrations/channels/discord.md create mode 100644 docs/ja/integrations/channels/feishu.md create mode 100644 docs/ja/integrations/channels/index.md create mode 100644 docs/ja/integrations/channels/line.md create mode 100644 docs/ja/integrations/channels/qq.md create mode 100644 docs/ja/integrations/channels/slack.md create mode 100644 docs/ja/integrations/channels/telegram.md create mode 100644 docs/ja/integrations/channels/wecom.md create mode 100644 docs/ja/integrations/channels/weixin.md create mode 100644 docs/ja/integrations/index.md create mode 100644 docs/ja/integrations/providers/llm.md create mode 100644 docs/ja/integrations/providers/memory/builtin.md create mode 100644 docs/ja/integrations/providers/video.md create mode 100644 docs/ja/integrations/providers/web-search.md create mode 100644 docs/ja/memory-providers/builtin.md create mode 100644 docs/ja/memory-providers/index.md create mode 100644 docs/ja/self-hosted/connectors.md create mode 100644 docs/ja/self-hosted/desktop.md create mode 100644 docs/ja/self-hosted/docker.md create mode 100644 docs/ja/self-hosted/index.md create mode 100644 docs/ja/self-hosted/workspace-backends.md create mode 100644 docs/ru/about.md create mode 100644 docs/ru/channels/dingtalk.md create mode 100644 docs/ru/channels/discord.md create mode 100644 docs/ru/channels/feishu.md create mode 100644 docs/ru/channels/index.md create mode 100644 docs/ru/channels/qq.md create mode 100644 docs/ru/channels/slack.md create mode 100644 docs/ru/channels/telegram.md create mode 100644 docs/ru/channels/wecom.md create mode 100644 docs/ru/channels/weixin.md create mode 100644 docs/ru/getting-started/access.md create mode 100644 docs/ru/getting-started/acp.md create mode 100644 docs/ru/getting-started/bot.md create mode 100644 docs/ru/getting-started/browser-computer-use.md create mode 100644 docs/ru/getting-started/channels.md create mode 100644 docs/ru/getting-started/compaction.md create mode 100644 docs/ru/getting-started/container.md create mode 100644 docs/ru/getting-started/files.md create mode 100644 docs/ru/getting-started/heartbeat.md create mode 100644 docs/ru/getting-started/mcp.md create mode 100644 docs/ru/getting-started/memory.md create mode 100644 docs/ru/getting-started/plugins.md create mode 100644 docs/ru/getting-started/provider-and-model.md create mode 100644 docs/ru/getting-started/schedule.md create mode 100644 docs/ru/getting-started/search-provider.md create mode 100644 docs/ru/getting-started/sessions.md create mode 100644 docs/ru/getting-started/skills.md create mode 100644 docs/ru/getting-started/slash-commands.md create mode 100644 docs/ru/getting-started/supermarket.md create mode 100644 docs/ru/guides/access.md create mode 100644 docs/ru/guides/acp.md create mode 100644 docs/ru/guides/approvals.md create mode 100644 docs/ru/guides/bot.md create mode 100644 docs/ru/guides/browser-computer-use.md create mode 100644 docs/ru/guides/compaction.md create mode 100644 docs/ru/guides/container.md create mode 100644 docs/ru/guides/extensions.md create mode 100644 docs/ru/guides/files.md create mode 100644 docs/ru/guides/get-started.md create mode 100644 docs/ru/guides/hooks.md create mode 100644 docs/ru/guides/index.md create mode 100644 docs/ru/guides/mcp.md create mode 100644 docs/ru/guides/memory.md create mode 100644 docs/ru/guides/overview.md create mode 100644 docs/ru/guides/quick-start.md create mode 100644 docs/ru/guides/schedule.md create mode 100644 docs/ru/guides/sessions.md create mode 100644 docs/ru/guides/skills.md create mode 100644 docs/ru/guides/slash-commands.md create mode 100644 docs/ru/guides/supermarket.md create mode 100644 docs/ru/guides/working-with-bots.md create mode 100644 docs/ru/index.md create mode 100644 docs/ru/installation/desktop.md create mode 100644 docs/ru/installation/docker.md create mode 100644 docs/ru/installation/index.md create mode 100644 docs/ru/installation/kata-containerd.md create mode 100644 docs/ru/installation/sqlite.md create mode 100644 docs/ru/installation/workspace-backends.md create mode 100644 docs/ru/integrations/channels/dingtalk.md create mode 100644 docs/ru/integrations/channels/discord.md create mode 100644 docs/ru/integrations/channels/feishu.md create mode 100644 docs/ru/integrations/channels/index.md create mode 100644 docs/ru/integrations/channels/line.md create mode 100644 docs/ru/integrations/channels/qq.md create mode 100644 docs/ru/integrations/channels/slack.md create mode 100644 docs/ru/integrations/channels/telegram.md create mode 100644 docs/ru/integrations/channels/wecom.md create mode 100644 docs/ru/integrations/channels/weixin.md create mode 100644 docs/ru/integrations/index.md create mode 100644 docs/ru/integrations/providers/llm.md create mode 100644 docs/ru/integrations/providers/memory/builtin.md create mode 100644 docs/ru/integrations/providers/video.md create mode 100644 docs/ru/integrations/providers/web-search.md create mode 100644 docs/ru/memory-providers/builtin.md create mode 100644 docs/ru/memory-providers/index.md create mode 100644 docs/ru/self-hosted/connectors.md create mode 100644 docs/ru/self-hosted/desktop.md create mode 100644 docs/ru/self-hosted/docker.md create mode 100644 docs/ru/self-hosted/index.md create mode 100644 docs/ru/self-hosted/workspace-backends.md delete mode 100644 docs/use-cases/code-and-preview.md delete mode 100644 docs/use-cases/data-upkeep.md delete mode 100644 docs/use-cases/gated-web-tasks.md delete mode 100644 docs/use-cases/group-duty-assistant.md delete mode 100644 docs/use-cases/index.md delete mode 100644 docs/use-cases/morning-briefing.md delete mode 100644 docs/use-cases/personal-assistant.md delete mode 100644 docs/use-cases/release-watch.md delete mode 100644 docs/zh/guides/use-cases.md delete mode 100644 docs/zh/use-cases/code-and-preview.md delete mode 100644 docs/zh/use-cases/data-upkeep.md delete mode 100644 docs/zh/use-cases/gated-web-tasks.md delete mode 100644 docs/zh/use-cases/group-duty-assistant.md delete mode 100644 docs/zh/use-cases/index.md delete mode 100644 docs/zh/use-cases/morning-briefing.md delete mode 100644 docs/zh/use-cases/personal-assistant.md delete mode 100644 docs/zh/use-cases/release-watch.md diff --git a/.github/workflows/docs-parity.yml b/.github/workflows/docs-parity.yml index c09e72e..20ff4f1 100644 --- a/.github/workflows/docs-parity.yml +++ b/.github/workflows/docs-parity.yml @@ -13,5 +13,5 @@ jobs: with: node-version: 22 - - name: Check en/zh locale parity + - name: Check locale parity (en/zh/ja/ru) run: node scripts/check-locale-parity.mjs diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3f382c4..157bd88 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,16 +2,18 @@ This guide covers how documentation is structured, translated, and checked in this repository. A complete Chinese version follows at the bottom (中文对照). -## Keep the Two Locales in Lockstep +## Keep the Locales in Lockstep - English pages live under `docs/`. -- Chinese pages live under `docs/zh/` with **identical paths**: `docs/guides/memory.md` mirrors to `docs/zh/guides/memory.md`. -- **Every content PR updates both locales.** English is the source of truth; the Chinese mirror lands **in the same PR**, never in a follow-up. +- Chinese, Japanese, and Russian pages live under `docs/zh/`, `docs/ja/`, and `docs/ru/` with **identical paths**: `docs/guides/memory.md` mirrors to `docs/zh/guides/memory.md`, `docs/ja/guides/memory.md`, and `docs/ru/guides/memory.md`. +- **Every content PR updates all locales.** English is the source of truth; the Chinese, Japanese, and Russian mirrors land **in the same PR**, never in a follow-up. ## Use the Terminology Glossary Translate product terms exactly as listed. Where a term has a product UI key, the **bold UI label** in the docs must use the product's own locale string for that key — never a re-translation of the English value. +The table below lists English/Chinese; for Japanese, use the product's `ja.json` string for the same UI key (e.g. workspace tab = **Workspace**, Platforms tab = **プラットフォーム**, Supermarket = **マーケットプレイス**, Apps tab = **アプリ**, skill = スキル, connector = コネクター, dependencies = 依存関係). The product has **no Russian UI locale**: in Russian pages every bold UI label stays as the English UI string, with an optional Russian gloss in parentheses on first mention. + | English | 中文 | Product UI key | |---------|------|----------------| | Bot | Bot | - | @@ -73,7 +75,7 @@ This keeps links stable across locales and rewordings. node scripts/check-locale-parity.mjs ``` -It must pass. It verifies that every page under `docs/` has its mirror under `docs/zh/` (and vice versa), and that the sidebars in `docs/.vitepress/en.ts` and `docs/.vitepress/zh.ts` link the same set of pages. CI runs the same script on every pull request. +It must pass. It verifies that every page under `docs/` has its mirror under `docs/zh/`, `docs/ja/`, and `docs/ru/` (and vice versa), and that the sidebars in `docs/.vitepress/en.ts`, `zh.ts`, `ja.ts`, and `ru.ts` link the same set of pages. CI runs the same script on every pull request. --- @@ -81,11 +83,11 @@ It must pass. It verifies that every page under `docs/` has its mirror under `do 本指南说明这个仓库里文档怎么组织、怎么翻译、怎么检查。 -## 两种语言同步走 +## 多语言同步走 - 英文页面在 `docs/` 下。 -- 中文页面在 `docs/zh/` 下,**路径完全一致**:`docs/guides/memory.md` 对应 `docs/zh/guides/memory.md`。 -- **每个内容 PR 同时更新两种语言。** 英文是唯一事实来源;中文镜像**在同一个 PR 里**落地,不留到后续 PR。 +- 中文、日文、俄文页面分别在 `docs/zh/`、`docs/ja/`、`docs/ru/` 下,**路径完全一致**:`docs/guides/memory.md` 对应 `docs/zh/guides/memory.md`、`docs/ja/guides/memory.md` 与 `docs/ru/guides/memory.md`。 +- **每个内容 PR 同时更新所有语言。** 英文是唯一事实来源;中文、日文、俄文镜像**在同一个 PR 里**落地,不留到后续 PR。 ## 按术语表翻译 @@ -127,7 +129,7 @@ It must pass. It verifies that every page under `docs/` has its mirror under `do ## 给可深链的标题加显式锚点 -FAQ 条目和所有要被深链的标题带显式 ASCII `{#id}`,**两种语言完全相同**: +FAQ 条目和所有要被深链的标题带显式 ASCII `{#id}`,**所有语言完全相同**: ```md @@ -152,4 +154,4 @@ FAQ 条目和所有要被深链的标题带显式 ASCII `{#id}`,**两种语言 node scripts/check-locale-parity.mjs ``` -必须通过。它检查 `docs/` 下每个页面在 `docs/zh/` 下都有镜像(反之亦然),并且 `docs/.vitepress/en.ts` 与 `docs/.vitepress/zh.ts` 两份侧栏链接同一组页面。CI 会在每个 pull request 上跑同一个脚本。 +必须通过。它检查 `docs/` 下每个页面在 `docs/zh/`、`docs/ja/`、`docs/ru/` 下都有镜像(反之亦然),并且 `docs/.vitepress/en.ts`、`zh.ts`、`ja.ts`、`ru.ts` 各份侧栏链接同一组页面。CI 会在每个 pull request 上跑同一个脚本。 diff --git a/README.md b/README.md index 2ef2aae..5b85536 100644 --- a/README.md +++ b/README.md @@ -25,25 +25,23 @@ The product source code lives in [`felinics/Memoh`](https://github.com/felinics/ - **Guides** for SaaS/product usage: bots, workspaces, sessions, memory, MCP, email, scheduled tasks, and slash commands. - **Integrations** for channels and providers, including messaging platforms, LLMs, memory providers, TTS, and web search. - **Self-hosted** docs for Desktop, Server Deploy, workspace backends, Kata, and SQLite. -- **English and Chinese docs** under `docs/` and `docs/zh/`. +- **English, Chinese, Japanese, and Russian docs** under `docs/`, `docs/zh/`, `docs/ja/`, and `docs/ru/`. - **Static assets** under `docs/public/`, including screenshots and logos. - **VitePress config** under `docs/.vitepress/`. ## Documentation Structure -The current VitePress site is organized around four primary navigation roots: +The current VitePress site is organized around three primary navigation roots: - `docs/guides/` for product usage guides. - `docs/integrations/` for channels, providers, memory providers, TTS, and web search. - `docs/self-hosted/` for Desktop, Server Deploy, workspace backends, and connectors (Connect-It). -- `docs/use-cases/` for ready-to-follow scenarios, one chapter per case. -The Simplified Chinese mirror uses the same structure under `docs/zh/`: +The Simplified Chinese, Japanese, and Russian mirrors use the same structure under `docs/zh/`, `docs/ja/`, and `docs/ru/`: -- `docs/zh/guides/` -- `docs/zh/integrations/` -- `docs/zh/self-hosted/` -- `docs/zh/use-cases/` +- `docs/zh/guides/`, `docs/ja/guides/`, `docs/ru/guides/` +- `docs/zh/integrations/`, `docs/ja/integrations/`, `docs/ru/integrations/` +- `docs/zh/self-hosted/`, `docs/ja/self-hosted/`, `docs/ru/self-hosted/` Legacy paths still exist for old external links, but they are redirect pages instead of the main content source: @@ -55,7 +53,7 @@ Legacy paths still exist for old external links, but they are redirect pages ins When updating content, edit the primary paths above first. Only touch a legacy redirect page when the redirect target itself changes. -Keep the English and Simplified Chinese docs mirrored. If you add, rename, remove, or move a page in one language, make the matching change in the other language and update both VitePress sidebar files. +Keep the English, Simplified Chinese, Japanese, and Russian docs mirrored. If you add, rename, remove, or move a page in one language, make the matching change in the other languages and update every VitePress sidebar file. Do not edit `docs/.vitepress/dist/` by hand. It is generated build output and should not be treated as source documentation. @@ -95,13 +93,14 @@ pnpm preview │ ├── guides/ # Product usage guides │ ├── integrations/ # Channels and providers │ ├── self-hosted/ # Open-source deployment docs -│ ├── use-cases/ # Use-case chapters │ ├── getting-started/ # Legacy redirects to guides │ ├── installation/ # Legacy redirects to self-hosted │ ├── channels/ # Legacy redirects to integrations/channels │ ├── memory-providers/ # Legacy redirects to integrations/providers/memory │ ├── public/ # Static images and logo │ ├── zh/ # Simplified Chinese documentation and redirects +│ ├── ja/ # Japanese documentation and redirects +│ ├── ru/ # Russian documentation and redirects │ └── *.md # Landing and compatibility pages ├── package.json └── pnpm-lock.yaml @@ -111,9 +110,11 @@ pnpm preview ### 2026-10 -- **Client-first corrections round**: top nav is now Guides / Use Cases / Help Center (Integrations and About removed); Use Cases split into its own directory with one chapter per scenario; the Deployment sidebar group is back (Server Deploy, Workspace Backends, Connectors). +- **Client-first corrections round**: top nav is now Guides / Help Center (Integrations and About removed); the Deployment sidebar group is back (Server Deploy, Workspace Backends, Connectors). - **Apps model**: Supermarket and Skills pages rewritten around the unified App concept (an App bundles Skills, dependencies, and connectors); Skills now documents workspace directories instead of a removed management UI; Connectors moved to the Deployment section. - **Cloud-baseline Workspace page**: open-source backend configuration and CDI/GPU passthrough moved to Workspace Backends; Preferences page removed; Memory provider entries consolidated into one; TTS: Edge removed. +- **Use Cases removed**: the AI-drafted Use Cases section is gone from nav, sidebar, and pages; it will return as human-written chapters with real screenshots and recordings. +- **Japanese and Russian locales**: full ja and ru translations under `docs/ja/` and `docs/ru/` with their own navs and sidebars. Japanese terminology is aligned with the product's Japanese UI strings; Russian keeps UI labels in English because the product has no Russian UI. The parity script now checks en/zh/ja/ru. ### 2026-09 diff --git a/README_CN.md b/README_CN.md index 359da64..900efcc 100644 --- a/README_CN.md +++ b/README_CN.md @@ -25,25 +25,23 @@ - **教程**:面向 SaaS/产品使用,覆盖机器人、workspace、会话、记忆、MCP、邮件、计划任务和斜杠命令。 - **集成**:渠道和提供方,包括消息平台、LLM、记忆提供方、TTS 和网页搜索。 - **自托管**:Desktop、Server Deploy、workspace backend、Kata 和 SQLite 等开源部署文档。 -- 英文和中文文档,分别位于 `docs/` 和 `docs/zh/`。 +- 英文、中文、日文和俄文文档,分别位于 `docs/`、`docs/zh/`、`docs/ja/` 和 `docs/ru/`。 - 截图、logo 等静态资源,位于 `docs/public/`。 - VitePress 配置,位于 `docs/.vitepress/`。 ## 文档站结构 -当前 VitePress 文档站围绕四个主导航路径组织: +当前 VitePress 文档站围绕三个主导航路径组织: - `docs/guides/`:产品使用教程。 - `docs/integrations/`:渠道、提供方、记忆提供方、TTS 和网页搜索。 - `docs/self-hosted/`:Desktop、Server Deploy、workspace backend 和连接器(Connect-It)。 -- `docs/use-cases/`:使用场景,每个场景独立成章。 -简体中文文档使用相同结构,位于 `docs/zh/` 下: +简体中文、日文与俄文文档使用相同结构,分别位于 `docs/zh/`、`docs/ja/` 与 `docs/ru/` 下: -- `docs/zh/guides/` -- `docs/zh/integrations/` -- `docs/zh/self-hosted/` -- `docs/zh/use-cases/` +- `docs/zh/guides/`、`docs/ja/guides/`、`docs/ru/guides/` +- `docs/zh/integrations/`、`docs/ja/integrations/`、`docs/ru/integrations/` +- `docs/zh/self-hosted/`、`docs/ja/self-hosted/`、`docs/ru/self-hosted/` 旧路径仍然保留,用于兼容外部旧链接,但它们是重定向页面,不是主要内容源: @@ -95,13 +93,14 @@ pnpm preview │ ├── guides/ # 产品使用教程 │ ├── integrations/ # 渠道和提供方 │ ├── self-hosted/ # 开源自托管部署文档 -│ ├── use-cases/ # 使用场景章节 │ ├── getting-started/ # 到 guides 的旧路径重定向 │ ├── installation/ # 到 self-hosted 的旧路径重定向 │ ├── channels/ # 到 integrations/channels 的旧路径重定向 │ ├── memory-providers/ # 到 integrations/providers/memory 的旧路径重定向 │ ├── public/ # 静态图片和 logo │ ├── zh/ # 中文文档和重定向页面 +│ ├── ja/ # 日文文档和重定向页面 +│ ├── ru/ # 俄文文档和重定向页面 │ └── *.md # 入口和兼容页面 ├── package.json └── pnpm-lock.yaml @@ -111,9 +110,11 @@ pnpm preview ### 2026-10 -- **客户端优先修正**:顶栏改为 教程 / 使用场景 / 帮助中心(移除 集成 与 关于);使用场景拆分为独立目录、每个场景一章;侧边栏恢复自部署分组(Server Deploy、Workspace 后端、连接器)。 +- **客户端优先修正**:顶栏改为 教程 / 帮助中心(移除 集成 与 关于);侧边栏恢复自部署分组(Server Deploy、Workspace 后端、连接器)。 - **应用(App)模型**:应用市场与技能页面按统一的 App 概念重写(一个 App 打包 Skills、依赖和连接器);技能页改为说明工作区目录,不再描述已移除的管理界面;连接器移入自部署章节。 - **工作区页面以 Cloud 为基准**:开源后端配置与 CDI/GPU 透传移至 Workspace 后端;移除用户偏好页;记忆提供方条目合并为一个;移除 TTS: Edge。 +- **移除使用场景**:AI 起草的使用场景章节已从导航、侧边栏和页面中移除;将来以人工撰写、配真实截图与录屏的形式回归。 +- **日语版与俄语版**:`docs/ja/`、`docs/ru/` 下完整翻译,各自独立导航与侧边栏。日文术语对齐产品日文 UI 文案;俄文因产品无俄语界面,UI 名词保留英文。对齐脚本现在检查 en/zh/ja/ru 四语。 ### 2026-09 diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 30dd206..9f54162 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -2,6 +2,8 @@ import { defineConfig } from 'vitepress' import llmstxt from 'vitepress-plugin-llms' import { en } from './en' import { zh } from './zh' +import { ja } from './ja' +import { ru } from './ru' // https://vitepress.vuejs.org/config/app-configs export default defineConfig({ @@ -21,7 +23,6 @@ export default defineConfig({ themeConfig: { nav: [ { text: 'Guides', link: '/guides/' }, - { text: 'Use Cases', link: '/use-cases/' }, { text: 'Help Center', link: 'https://memoh.ai/help' }, ], }, @@ -32,10 +33,29 @@ export default defineConfig({ themeConfig: { nav: [ { text: '教程', link: '/zh/guides/' }, - { text: '使用场景', link: '/zh/use-cases/' }, { text: '帮助中心', link: 'https://memoh.ai/help' }, ], }, + }, + ja: { + label: '日本語', + lang: 'ja', + themeConfig: { + nav: [ + { text: 'ガイド', link: '/ja/guides/' }, + { text: 'ヘルプセンター', link: 'https://memoh.ai/help' }, + ], + }, + }, + ru: { + label: 'Русский', + lang: 'ru', + themeConfig: { + nav: [ + { text: 'Руководства', link: '/ru/guides/' }, + { text: 'Центр помощи', link: 'https://memoh.ai/help' }, + ], + }, } }, @@ -44,6 +64,8 @@ export default defineConfig({ sidebar: { ...en, ...zh, + ...ja, + ...ru, }, diff --git a/docs/.vitepress/en.ts b/docs/.vitepress/en.ts index 8a2dc08..90770f5 100644 --- a/docs/.vitepress/en.ts +++ b/docs/.vitepress/en.ts @@ -55,19 +55,6 @@ const references = [ { text: 'Memory', link: '/integrations/providers/memory/builtin.md' }, ], }, - { - text: 'Use Cases', - items: [ - { text: 'Overview', link: '/use-cases/' }, - { text: 'Morning Digest', link: '/use-cases/morning-briefing.md' }, - { text: 'Release Watch', link: '/use-cases/release-watch.md' }, - { text: 'Group On-Call Assistant', link: '/use-cases/group-duty-assistant.md' }, - { text: 'A Living Spreadsheet', link: '/use-cases/data-upkeep.md' }, - { text: 'Screen Work Behind Logins', link: '/use-cases/gated-web-tasks.md' }, - { text: 'Build and Preview in the Cloud', link: '/use-cases/code-and-preview.md' }, - { text: 'An Assistant That Remembers', link: '/use-cases/personal-assistant.md' }, - ], - }, { text: 'Deployment', items: [ @@ -83,5 +70,4 @@ export const en = { '/guides/': references, '/integrations/': references, '/self-hosted/': references, - '/use-cases/': references, } diff --git a/docs/.vitepress/ja.ts b/docs/.vitepress/ja.ts new file mode 100644 index 0000000..3522ded --- /dev/null +++ b/docs/.vitepress/ja.ts @@ -0,0 +1,73 @@ +const references = [ + { + text: 'リファレンス', + items: [ + { text: '総覧', link: '/ja/guides/' }, + ], + }, + { + text: 'はじめに', + items: [ + { text: '概要', link: '/ja/guides/overview.md' }, + { text: 'クイックスタート', link: '/ja/guides/quick-start.md' }, + { text: 'Bot との協働', link: '/ja/guides/working-with-bots.md' }, + { text: 'セッション', link: '/ja/guides/sessions.md' }, + { text: 'ファイル', link: '/ja/guides/files.md' }, + { text: 'スラッシュコマンド', link: '/ja/guides/slash-commands.md' }, + { text: 'デスクトップアプリ', link: '/ja/self-hosted/desktop.md' }, + { + text: 'チャネル', + collapsed: true, + items: [ + { text: '総覧', link: '/ja/integrations/channels/' }, + { text: 'Slack', link: '/ja/integrations/channels/slack.md' }, + { text: 'Telegram', link: '/ja/integrations/channels/telegram.md' }, + { text: 'Feishu (Lark)', link: '/ja/integrations/channels/feishu.md' }, + { text: 'Discord', link: '/ja/integrations/channels/discord.md' }, + { text: 'QQ', link: '/ja/integrations/channels/qq.md' }, + { text: 'LINE', link: '/ja/integrations/channels/line.md' }, + { text: 'DingTalk', link: '/ja/integrations/channels/dingtalk.md' }, + { text: 'WeCom', link: '/ja/integrations/channels/wecom.md' }, + { text: 'WeChat', link: '/ja/integrations/channels/weixin.md' }, + ], + }, + ], + }, + { + text: '高度な機能', + items: [ + { text: '拡張機能の選び方', link: '/ja/guides/extensions.md' }, + { text: 'Agents / ACP', link: '/ja/guides/acp.md' }, + { text: '承認と信頼', link: '/ja/guides/approvals.md' }, + { text: 'アクセス制御', link: '/ja/guides/access.md' }, + { text: 'ワークスペース', link: '/ja/guides/container.md' }, + { text: 'Browser / Computer Use', link: '/ja/guides/browser-computer-use.md' }, + { text: 'スキル', link: '/ja/guides/skills.md' }, + { text: 'マーケットプレイス', link: '/ja/guides/supermarket.md' }, + { text: 'Hooks', link: '/ja/guides/hooks.md' }, + { text: 'MCP', link: '/ja/guides/mcp.md' }, + { text: '長期メモリ', link: '/ja/guides/memory.md' }, + { text: 'コンテキスト圧縮', link: '/ja/guides/compaction.md' }, + { text: 'スケジュールタスク', link: '/ja/guides/schedule.md' }, + { text: 'モデルプロバイダー', link: '/ja/integrations/providers/llm.md' }, + { text: 'ウェブ検索プロバイダー', link: '/ja/integrations/providers/web-search.md' }, + { text: '動画プロバイダー', link: '/ja/integrations/providers/video.md' }, + { text: 'メモリ', link: '/ja/integrations/providers/memory/builtin.md' }, + ], + }, + { + text: 'セルフホスト', + items: [ + { text: '概要', link: '/ja/self-hosted/' }, + { text: 'Server Deploy', link: '/ja/self-hosted/docker.md' }, + { text: 'Workspace バックエンド', link: '/ja/self-hosted/workspace-backends.md' }, + { text: 'コネクター(Connect-It)', link: '/ja/self-hosted/connectors.md' }, + ], + }, +] + +export const ja = { + '/ja/guides/': references, + '/ja/integrations/': references, + '/ja/self-hosted/': references, +} diff --git a/docs/.vitepress/ru.ts b/docs/.vitepress/ru.ts new file mode 100644 index 0000000..01c12af --- /dev/null +++ b/docs/.vitepress/ru.ts @@ -0,0 +1,73 @@ +const references = [ + { + text: 'Справочник', + items: [ + { text: 'Обзор', link: '/ru/guides/' }, + ], + }, + { + text: 'Начало работы', + items: [ + { text: 'Обзор', link: '/ru/guides/overview.md' }, + { text: 'Быстрый старт', link: '/ru/guides/quick-start.md' }, + { text: 'Работа с Bot', link: '/ru/guides/working-with-bots.md' }, + { text: 'Сессии', link: '/ru/guides/sessions.md' }, + { text: 'Файлы', link: '/ru/guides/files.md' }, + { text: 'Слэш-команды', link: '/ru/guides/slash-commands.md' }, + { text: 'Настольное приложение', link: '/ru/self-hosted/desktop.md' }, + { + text: 'Каналы', + collapsed: true, + items: [ + { text: 'Обзор', link: '/ru/integrations/channels/' }, + { text: 'Slack', link: '/ru/integrations/channels/slack.md' }, + { text: 'Telegram', link: '/ru/integrations/channels/telegram.md' }, + { text: 'Feishu (Lark)', link: '/ru/integrations/channels/feishu.md' }, + { text: 'Discord', link: '/ru/integrations/channels/discord.md' }, + { text: 'QQ', link: '/ru/integrations/channels/qq.md' }, + { text: 'LINE', link: '/ru/integrations/channels/line.md' }, + { text: 'DingTalk', link: '/ru/integrations/channels/dingtalk.md' }, + { text: 'WeCom', link: '/ru/integrations/channels/wecom.md' }, + { text: 'WeChat', link: '/ru/integrations/channels/weixin.md' }, + ], + }, + ], + }, + { + text: 'Продвинутые возможности', + items: [ + { text: 'Выбор расширения', link: '/ru/guides/extensions.md' }, + { text: 'Agents / ACP', link: '/ru/guides/acp.md' }, + { text: 'Подтверждения и доверие', link: '/ru/guides/approvals.md' }, + { text: 'Контроль доступа', link: '/ru/guides/access.md' }, + { text: 'Рабочее пространство', link: '/ru/guides/container.md' }, + { text: 'Browser / Computer Use', link: '/ru/guides/browser-computer-use.md' }, + { text: 'Навыки', link: '/ru/guides/skills.md' }, + { text: 'Supermarket', link: '/ru/guides/supermarket.md' }, + { text: 'Hooks', link: '/ru/guides/hooks.md' }, + { text: 'MCP', link: '/ru/guides/mcp.md' }, + { text: 'Долговременная память', link: '/ru/guides/memory.md' }, + { text: 'Сжатие контекста', link: '/ru/guides/compaction.md' }, + { text: 'Задачи по расписанию', link: '/ru/guides/schedule.md' }, + { text: 'Провайдеры моделей', link: '/ru/integrations/providers/llm.md' }, + { text: 'Провайдеры веб-поиска', link: '/ru/integrations/providers/web-search.md' }, + { text: 'Провайдеры видео', link: '/ru/integrations/providers/video.md' }, + { text: 'Память', link: '/ru/integrations/providers/memory/builtin.md' }, + ], + }, + { + text: 'Развёртывание', + items: [ + { text: 'Обзор', link: '/ru/self-hosted/' }, + { text: 'Server Deploy', link: '/ru/self-hosted/docker.md' }, + { text: 'Бэкенды рабочих пространств', link: '/ru/self-hosted/workspace-backends.md' }, + { text: 'Коннекторы (Connect-It)', link: '/ru/self-hosted/connectors.md' }, + ], + }, +] + +export const ru = { + '/ru/guides/': references, + '/ru/integrations/': references, + '/ru/self-hosted/': references, +} diff --git a/docs/.vitepress/theme/components/DocsHome.vue b/docs/.vitepress/theme/components/DocsHome.vue index dade1c1..9536e78 100644 --- a/docs/.vitepress/theme/components/DocsHome.vue +++ b/docs/.vitepress/theme/components/DocsHome.vue @@ -2,12 +2,84 @@ import { computed } from 'vue' const props = defineProps<{ - locale?: 'en' | 'zh' + locale?: 'en' | 'zh' | 'ja' | 'ru' }>() const isZh = computed(() => props.locale === 'zh') +const isJa = computed(() => props.locale === 'ja') +const isRu = computed(() => props.locale === 'ru') const copy = computed(() => { + if (isRu.value) { + return { + sections: [ + { + tone: 'guide', + icon: 'rocket', + title: 'Быстрый старт', + text: 'Установите приложение, войдите, создайте первого Bot, дайте ему настоящую задачу и подключите чат-платформу.', + href: '/ru/guides/quick-start', + }, + { + tone: 'guide', + icon: 'book', + title: 'Продвинутые возможности', + text: 'Продвинутые возможности, автоматизация и внешние провайдеры — агенты, Hooks, долговременная память и не только.', + href: '/ru/guides/', + }, + { + tone: 'integration', + icon: 'plug', + title: 'Развёртывание', + text: 'Запустите Memoh на своём сервере: Server Deploy, бэкенды рабочих пространств, коннекторы.', + href: '/ru/self-hosted/', + }, + { + tone: 'hosted', + icon: 'server', + title: 'Центр помощи', + text: 'Вопросы о планах, оплате и аккаунте, а также прямая связь с командой Memoh.', + href: 'https://memoh.ai/help', + }, + ], + } + } + + if (isJa.value) { + return { + sections: [ + { + tone: 'guide', + icon: 'rocket', + title: 'クイックスタート', + text: 'アプリをインストールしてサインインし、最初の Bot を作成。実際のタスクを任せ、チャットプラットフォームにつなぎます。', + href: '/ja/guides/quick-start', + }, + { + tone: 'guide', + icon: 'book', + title: '高度な機能', + text: '高度な機能・自動化・外部プロバイダー——エージェント、Hooks、長期メモリなど。', + href: '/ja/guides/', + }, + { + tone: 'integration', + icon: 'plug', + title: 'セルフホスト', + text: '自分のサーバーで Memoh を動かす:Server Deploy、Workspace バックエンド、コネクター。', + href: '/ja/self-hosted/', + }, + { + tone: 'hosted', + icon: 'server', + title: 'ヘルプセンター', + text: 'プラン・請求・アカウントの質問、そして Memoh チームへの連絡窓口。', + href: 'https://memoh.ai/help', + }, + ], + } + } + if (isZh.value) { return { sections: [ @@ -28,9 +100,9 @@ const copy = computed(() => { { tone: 'integration', icon: 'plug', - title: '使用场景', - text: '组合多种功能解决实际问题的即用型示例。', - href: '/zh/use-cases/', + title: '自部署', + text: '在自己的服务器上运行 Memoh:Server Deploy、Workspace 后端与连接器。', + href: '/zh/self-hosted/', }, { tone: 'hosted', @@ -62,9 +134,9 @@ const copy = computed(() => { { tone: 'integration', icon: 'plug', - title: 'Use Cases', - text: 'Ready-to-follow scenarios that combine features to solve real problems.', - href: '/use-cases/', + title: 'Deployment', + text: 'Run Memoh on your own server: Server Deploy, workspace backends, and connectors.', + href: '/self-hosted/', }, { tone: 'hosted', @@ -79,7 +151,7 @@ const copy = computed(() => {