Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,16 @@ This keeps links stable across locales and rewordings.
- Every destructive action notes what it does **not** undo. Example: "Deleting a session removes its message history permanently; it does not delete memories already extracted from it."
- Example prompts end with a safety constraint. Example: "Summarize this thread and draft a reply, and ask me before sending anything."

## Announce Releases in What's New, Not a Changelog

`docs/whats-new.md` (mirrored in every locale) is a curated digest of changes that alter how someone uses Memoh. The exhaustive per-version record is the [GitHub release notes](https://github.com/felinics/Memoh/releases); the docs keep no changelog page of their own.

- **Belongs in What's new:** new agents and capabilities, user-visible workflow changes, notable performance wins, and Memoh Cloud notices such as plan or billing changes. Release announcements (for example, posts on X) map here.
- **Stays in the release notes only:** refactors, error-code plumbing, test fixes, dependency bumps, and other changes nobody would notice while using the product.
- **One section per announcement**, newest first, headed by its date with an explicit anchor: `## October 19, 2026 {#2026-10-19}`. Entries are `###` headings that lead with a verb and carry `{#YYYY-MM-DD-short-slug}`, so deep links match across locales.
- **Each entry** is one to three short paragraphs that link to the docs page for the feature. End the section with a link to that version's GitHub release.
- **Update the feature docs first.** An entry must never link to a page that contradicts it.

## Run the Parity Check Before Opening a PR

```sh
Expand Down Expand Up @@ -148,6 +158,16 @@ FAQ 条目和所有要被深链的标题带显式 ASCII `{#id}`,**所有语言
- 每个破坏性操作都写明它**不会**撤销什么。例:「删除会话会永久移除消息历史;已经从中抽取的记忆不会随之删除。」
- 示例提示词以安全约束收尾。例:「总结这个帖子并起草回复,发送任何内容前先问我。」

## 版本更新写进最新动态,不另建 changelog

`docs/whats-new.md`(每种语言都有镜像)是精选的更新速览,只收录会改变使用方式的变化。按版本穷举的完整记录是 [GitHub Release](https://github.com/felinics/Memoh/releases),文档站不再单独维护 changelog 页面。

- **写进最新动态:** 新的 Agent 和能力、用户能感知到的流程变化、明显的性能提升,以及 Memoh Cloud 的套餐、计费等通知。发版公告(例如 X 上的推文)就对应这里。
- **只留在 Release 里:** 重构、错误码梳理、测试修复、依赖升级等使用时察觉不到的改动。
- **每次公告一节**,最新的在最上面,标题写日期并带显式锚点:`## 2026 年 10 月 19 日 {#2026-10-19}`。条目用 `###` 标题、以动词开头,并带 `{#YYYY-MM-DD-short-slug}`,保证各语言深链一致。
- **每个条目**一到三段短文,链接到该功能的文档页。这一节最后链接到对应版本的 GitHub Release。
- **先更新功能文档。** 条目链接过去的页面不能和条目内容矛盾。

## 发 PR 前跑一致性检查

```sh
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ The product source code lives in [`felinics/Memoh`](https://github.com/felinics/
- **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, Chinese, Japanese, and Russian docs** under `docs/`, `docs/zh/`, `docs/ja/`, and `docs/ru/`.
- **What's new** in `docs/whats-new.md`: a curated digest of release highlights. The full per-version changelog lives in [GitHub Releases](https://github.com/felinics/Memoh/releases).
- **Static assets** under `docs/public/`, including screenshots and logos.
- **VitePress config** under `docs/.vitepress/`.

Expand Down Expand Up @@ -101,6 +102,7 @@ pnpm preview
│ ├── zh/ # Simplified Chinese documentation and redirects
│ ├── ja/ # Japanese documentation and redirects
│ ├── ru/ # Russian documentation and redirects
│ ├── whats-new.md # Release highlights digest
│ └── *.md # Landing and compatibility pages
├── package.json
└── pnpm-lock.yaml
Expand All @@ -110,6 +112,7 @@ pnpm preview

### 2026-10

- **What's new page**: a curated digest of release highlights in every locale, linked from the top nav; GitHub Releases remains the full changelog. First entry: the October 19 update (Grok Build, cloud desktop copy and paste, scheduled-task sessions, prompt-cache fixes). Agents / ACP now documents Grok Build.
- **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.
Expand Down
3 changes: 3 additions & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
- **集成**:渠道和提供方,包括消息平台、LLM、记忆提供方、TTS 和网页搜索。
- **自托管**:Desktop、Server Deploy、workspace backend、Kata 和 SQLite 等开源部署文档。
- 英文、中文、日文和俄文文档,分别位于 `docs/`、`docs/zh/`、`docs/ja/` 和 `docs/ru/`。
- 最新动态,位于 `docs/whats-new.md`:精选的版本更新速览。按版本的完整更新日志见 [GitHub Releases](https://github.com/felinics/Memoh/releases)。
- 截图、logo 等静态资源,位于 `docs/public/`。
- VitePress 配置,位于 `docs/.vitepress/`。

Expand Down Expand Up @@ -101,6 +102,7 @@ pnpm preview
│ ├── zh/ # 中文文档和重定向页面
│ ├── ja/ # 日文文档和重定向页面
│ ├── ru/ # 俄文文档和重定向页面
│ ├── whats-new.md # 版本更新速览
│ └── *.md # 入口和兼容页面
├── package.json
└── pnpm-lock.yaml
Expand All @@ -110,6 +112,7 @@ pnpm preview

### 2026-10

- **最新动态页面**:各语言新增精选的版本更新速览,顶栏可直达;GitHub Releases 仍是完整的更新日志。第一条为 10 月 19 日更新(Grok Build、云桌面复制粘贴、定时任务会话、Prompt 缓存修复)。Agents / ACP 页补充 Grok Build。
- **客户端优先修正**:顶栏改为 教程 / 帮助中心(移除 集成 与 关于);侧边栏恢复自部署分组(Server Deploy、Workspace 后端、连接器)。
- **应用(App)模型**:应用市场与技能页面按统一的 App 概念重写(一个 App 打包 Skills、依赖和连接器);技能页改为说明工作区目录,不再描述已移除的管理界面;连接器移入自部署章节。
- **工作区页面以 Cloud 为基准**:开源后端配置与 CDI/GPU 透传移至 Workspace 后端;移除用户偏好页;记忆提供方条目合并为一个;移除 TTS: Edge。
Expand Down
4 changes: 4 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ export default defineConfig({
themeConfig: {
nav: [
{ text: 'Guides', link: '/guides/' },
{ text: "What's new", link: '/whats-new' },
{ text: 'Help Center', link: 'https://memoh.ai/help' },
],
},
Expand All @@ -33,6 +34,7 @@ export default defineConfig({
themeConfig: {
nav: [
{ text: '教程', link: '/zh/guides/' },
{ text: '最新动态', link: '/zh/whats-new' },
{ text: '帮助中心', link: 'https://memoh.ai/help' },
],
},
Expand All @@ -43,6 +45,7 @@ export default defineConfig({
themeConfig: {
nav: [
{ text: 'ガイド', link: '/ja/guides/' },
{ text: '新着情報', link: '/ja/whats-new' },
{ text: 'ヘルプセンター', link: 'https://memoh.ai/help' },
],
},
Expand All @@ -53,6 +56,7 @@ export default defineConfig({
themeConfig: {
nav: [
{ text: 'Руководства', link: '/ru/guides/' },
{ text: 'Что нового', link: '/ru/whats-new' },
{ text: 'Центр помощи', link: 'https://memoh.ai/help' },
],
},
Expand Down
2 changes: 2 additions & 0 deletions docs/.vitepress/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ const references = [
text: 'References',
items: [
{ text: 'Overview', link: '/guides/' },
{ text: "What's new", link: '/whats-new.md' },
],
},
{
Expand Down Expand Up @@ -70,4 +71,5 @@ export const en = {
'/guides/': references,
'/integrations/': references,
'/self-hosted/': references,
'/whats-new': references,
}
2 changes: 2 additions & 0 deletions docs/.vitepress/ja.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ const references = [
text: 'リファレンス',
items: [
{ text: '総覧', link: '/ja/guides/' },
{ text: '新着情報', link: '/ja/whats-new.md' },
],
},
{
Expand Down Expand Up @@ -70,4 +71,5 @@ export const ja = {
'/ja/guides/': references,
'/ja/integrations/': references,
'/ja/self-hosted/': references,
'/ja/whats-new': references,
}
2 changes: 2 additions & 0 deletions docs/.vitepress/ru.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ const references = [
text: 'Справочник',
items: [
{ text: 'Обзор', link: '/ru/guides/' },
{ text: 'Что нового', link: '/ru/whats-new.md' },
],
},
{
Expand Down Expand Up @@ -70,4 +71,5 @@ export const ru = {
'/ru/guides/': references,
'/ru/integrations/': references,
'/ru/self-hosted/': references,
'/ru/whats-new': references,
}
2 changes: 2 additions & 0 deletions docs/.vitepress/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ const references = [
text: '参考文档',
items: [
{ text: '总览', link: '/zh/guides/' },
{ text: '最新动态', link: '/zh/whats-new.md' },
],
},
{
Expand Down Expand Up @@ -70,4 +71,5 @@ export const zh = {
'/zh/guides/': references,
'/zh/integrations/': references,
'/zh/self-hosted/': references,
'/zh/whats-new': references,
}
19 changes: 17 additions & 2 deletions docs/guides/acp.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Memoh can connect a bot to ACP-compatible coding agents. ACP agents are external coding workflows that work from the bot's chat workspace while keeping their sessions separate from normal chat and discuss conversations.

Two agent profiles ship with Memoh: **Codex** and **Claude Code**. Treat them as supported setup paths, not as the only possible ACP-compatible agents over time.
Three agent profiles ship with Memoh: **Codex**, **Claude Code**, and **Grok Build**. Treat them as supported setup paths, not as the only possible ACP-compatible agents over time.

ACP agents run inside the bot's container workspace, so the bot must use a container-backed workspace backend.

Expand All @@ -23,6 +23,7 @@ A row shows one of three states: **Needs setup** (enabled but missing credential
|-------|---------|-------|--------------|
| **Codex** | ✅ | ✅ ChatGPT sign-in with device code | ✅ |
| **Claude Code** | ✅ | ✅ paste a token from `claude setup-token` | ✅ |
| **Grok Build** | ✅ xAI API key | ✅ Grok account sign-in with device code | — |

**Self-managed** means Memoh launches the agent against configuration you maintain yourself inside the workspace.

Expand All @@ -32,9 +33,23 @@ In the Codex settings, click **Use Device Code**. Memoh shows a verification URL

> Only enter the code on the displayed OpenAI verification URL — device codes can be used for phishing.

### Grok Build {#grok-build}

Grok Build authenticates with an xAI API key or your Grok account. While creating a bot you can only provide an API key; Grok account sign-in is available in the agent's settings once the bot exists. Memoh shows a verification page and a one-time code — confirm it only on the accounts.x.ai address shown there — and finishes authorization automatically. Memoh encrypts the agent's Grok credentials and provides them to Grok Build only at runtime.

Grok Build applies its own permission mode to its built-in tools:

| Mode | Behavior |
|------|----------|
| **Ask** (default) | Ask before each operation that has side effects. |
| **Auto** | Let Grok decide which operations are safe to run without asking. |
| **Always approve** | Approve every operation without asking. Memoh's own tool permissions still apply. |

The bot's **Tool Approval** rules govern only the tools Memoh provides. When Grok Build asks for approval, Memoh shows the request as a card for a user with the matching workspace permission to decide. Grok Build can fork a conversation only from its latest turn.

## Adapter Updates

The Codex and Claude Code adapters are npm-backed. Memoh resolves the adapter's latest published version once per server run (per bot) and launches that version, so adapter fixes arrive without upgrading Memoh itself. If the lookup or launch fails, Memoh falls back to the adapter version bundled in the workspace image until the next server restart.
The Codex and Claude Code adapters are npm-backed. Memoh resolves the adapter's latest published version once per server run (per bot) and launches that version, so adapter fixes arrive without upgrading Memoh itself. If the lookup or launch fails, Memoh falls back to the adapter version bundled in the workspace image until the next server restart. Grok Build needs no adapter: it speaks ACP natively, and Memoh runs the `grok` CLI provided as a managed workspace dependency.

---

Expand Down
19 changes: 17 additions & 2 deletions docs/ja/guides/acp.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Memoh は Bot を ACP 互換のコーディングエージェントに接続できます。ACP エージェントは外部のコーディングワークフローで、Bot のチャットワークスペースから作業しつつ、自分のセッションを通常の chat / discuss とは分けて保ちます。

組み込みの agent profile は **Codex** と **Claude Code** の 2 つです。これらは現時点でサポートされているセットアップ経路であって、今後接続できる ACP 互換エージェントがこれだけに限られるという意味ではありません。
組み込みの agent profile は **Codex**、**Claude Code**、**Grok Build** の 3 つです。これらは現時点でサポートされているセットアップ経路であって、今後接続できる ACP 互換エージェントがこれだけに限られるという意味ではありません。

ACP エージェントは Bot のコンテナワークスペース内で動くため、Bot はコンテナベースの Workspace バックエンドを使っている必要があります。

Expand All @@ -23,6 +23,7 @@ ACP エージェントは Bot のコンテナワークスペース内で動く
|--------|---------|-------|--------------|
| **Codex** | ✅ | ✅ ChatGPT ログイン(デバイスコード) | ✅ |
| **Claude Code** | ✅ | ✅ `claude setup-token` で生成した token を貼り付け | ✅ |
| **Grok Build** | ✅ xAI API Key | ✅ Grok アカウントでサインイン(デバイスコード) | — |

**Self-managed** は、あなたがワークスペース内で自分で管理している設定をそのまま使って、Memoh がエージェントを起動することを意味します。

Expand All @@ -32,9 +33,23 @@ Codex の設定で **Use Device Code** をクリックすると、Memoh が検

> ワンタイムコードは、表示された OpenAI の検証用 URL でだけ入力してください——デバイスコードはフィッシングに悪用されることがあります。

### Grok Build {#grok-build}

Grok Build は xAI API Key または Grok アカウントで認証します。Bot の作成時に入力できるのは API Key だけで、Grok アカウントでのサインインは Bot を作成したあとにエージェントの設定から行います。Memoh が認証ページとワンタイムコードを表示するので、表示された accounts.x.ai のページでだけ確認してください。認証は自動で完了します。Memoh はこのエージェントの Grok 認証情報を暗号化して保存し、実行時にのみ Grok Build に渡します。

Grok Build は組み込みツールに独自の権限モードを適用します:

| モード | 動作 |
|--------|------|
| **毎回確認**(既定) | 副作用のある操作を実行する前に確認します。 |
| **自動判断** | 安全に実行できる操作を Grok が判断し、確認を省きます。 |
| **すべて承認** | すべての操作を確認なしで承認します。Memoh ツールの権限は引き続き適用されます。 |

Bot の **Toolの承認** ルールが適用されるのは、Memoh が提供するツールだけです。Grok Build からの確認の要求はカードとして表示され、該当する Workspace 権限を持つユーザーが判断します。Grok Build が会話をフォークできるのは、最新のターンからだけです。

## Adapter の自動更新

Codex と Claude Code の adapter は npm パッケージです。Memoh はサービスプロセスの起動後に(Bot ごとに)1 回だけ npm 上の最新バージョンを解決してそれを起動するため、adapter の修正は Memoh 自体をアップグレードしなくても手に入ります。解決や起動に失敗した場合は、次のサービス再起動まで、ワークスペースイメージに同梱されたバージョンにフォールバックします。
Codex と Claude Code の adapter は npm パッケージです。Memoh はサービスプロセスの起動後に(Bot ごとに)1 回だけ npm 上の最新バージョンを解決してそれを起動するため、adapter の修正は Memoh 自体をアップグレードしなくても手に入ります。解決や起動に失敗した場合は、次のサービス再起動まで、ワークスペースイメージに同梱されたバージョンにフォールバックします。Grok Build には adapter は不要です。ACP にネイティブ対応しており、Memoh はマネージドなワークスペース依存関係として提供される `grok` CLI を実行します。

---

Expand Down
Loading
Loading