Skip to content
Merged
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ dist-ssr
*.sln
*.sw?

.vitepress/cache
**/.vitepress/cache
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,22 @@ pnpm preview
└── pnpm-lock.yaml
```

## Changelog

### 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.
- **New Get Started tutorial**: a step-by-step onboarding guide added for both English and Chinese docs; Overview now comes before Getting Started in the sidebar.
- **Framework**: evaluated a migration to Scalar Docs, then restored VitePress while keeping all content and structure changes intact.
- **Translation quality pass**: reviewed all 53 English/Chinese page pairs; fixed mistranslations (e.g. ACL presets, private channels, compaction behavior), typos, machine-translated phrasing, and terminology mismatches across 29 files, plus a plural typo in the English Matrix page.
- **Housekeeping**: `.gitignore` now correctly excludes `docs/.vitepress/cache`.

### Earlier

- Synced docs with the Memoh source and added Quick Start (#7).
- Added Connect-It connectors documentation (#5).
- Updated documentation for v0.17 (#4) and v0.13.

## Contributing

Small fixes are best made directly in the relevant Markdown page. For larger changes:
Expand Down
16 changes: 16 additions & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,22 @@ pnpm preview
└── pnpm-lock.yaml
```

## 更新日志

### 2026-09

- **导航结构重组**:文档统一收入单一的 **References(参考文档)** 树——快速开始(内含部署与渠道)、进阶教程(内含提供方 → 记忆/TTS 提供方)、使用场景。版本选择器移到页头右侧,并为每个页面加上编辑链接。
- **新增 Get Started 新手教程**:中英文各新增一份分步上手指南;侧边栏中 Overview 调整到 Getting Started 之前。
- **框架**:尝试迁移到 Scalar Docs 后还原回 VitePress,全部内容与结构改动均保留。
- **翻译质量核查**:全量核查 53 对中英文页面,修正误译(如 ACL 预设、私有频道、会话压缩描述)、错别字、机翻痕迹和术语不一致,共涉及 29 个文件;同时修复英文 Matrix 页面的一处单复数笔误。
- **杂项**:修正 `.gitignore`,正确排除 `docs/.vitepress/cache`。

### 更早

- 与 Memoh 源码同步并新增 Quick Start(#7)。
- 新增 Connect-It 连接器文档(#5)。
- 更新 v0.17(#4)与 v0.13 文档。

## 贡献文档

小的错别字、链接和措辞修正可以直接改对应 Markdown 页面。较大的结构调整建议这样做:
Expand Down
5 changes: 2 additions & 3 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,8 @@ export default defineConfig({
},

nav: [
{ text: 'Guides', link: '/guides/' },
{ text: 'Integrations', link: '/integrations/' },
{ text: 'Self-hosted', link: '/self-hosted/' },
{ text: 'References', link: '/guides/' },
{ text: 'About', link: '/about.md' },
],

logo: {
Expand Down
196 changes: 106 additions & 90 deletions docs/.vitepress/en.ts
Original file line number Diff line number Diff line change
@@ -1,92 +1,108 @@
const references = [
{
text: 'References',
items: [
{ text: 'Overview', link: '/guides/' },
],
},
{
text: 'Getting Started',
items: [
{ text: 'Get Started', link: '/guides/get-started.md' },
{ text: 'Quick Start', link: '/guides/quick-start.md' },
{ text: 'Preferences', link: '/guides/preferences.md' },
{ text: 'Bot', link: '/guides/bot.md' },
{ text: 'Sessions', link: '/guides/sessions.md' },
{ text: 'Files', link: '/guides/files.md' },
{ text: 'Slash Commands', link: '/guides/slash-commands.md' },
{
text: 'Deployment',
collapsed: true,
items: [
{ text: 'Server Deploy', link: '/self-hosted/docker.md' },
{ text: 'Desktop', link: '/self-hosted/desktop.md' },
{ text: 'Workspace Backends', link: '/self-hosted/workspace-backends.md' },
{ text: 'Overview', link: '/self-hosted/' },
],
},
{
text: 'Channels',
collapsed: true,
items: [
{ text: 'Slack', link: '/integrations/channels/slack.md' },
{ text: 'Telegram', link: '/integrations/channels/telegram.md' },
{ text: 'Feishu (Lark)', link: '/integrations/channels/feishu.md' },
{ text: 'Discord', link: '/integrations/channels/discord.md' },
{ text: 'QQ', link: '/integrations/channels/qq.md' },
{ text: 'Matrix', link: '/integrations/channels/matrix.md' },
{ text: 'Misskey', link: '/integrations/channels/misskey.md' },
{ text: 'LINE', link: '/integrations/channels/line.md' },
{ text: 'DingTalk', link: '/integrations/channels/dingtalk.md' },
{ text: 'WeCom (WeWork)', link: '/integrations/channels/wecom.md' },
{ text: 'WeChat', link: '/integrations/channels/weixin.md' },
{ text: 'WeChat Official Account', link: '/integrations/channels/wechatoa.md' },
{ text: 'Overview', link: '/integrations/channels/' },
],
},
],
},
{
text: 'Advanced',
items: [
{ text: 'Agents / ACP', link: '/guides/acp.md' },
{ text: 'Access Control', link: '/guides/access.md' },
{ text: 'Workspace', link: '/guides/container.md' },
{ text: 'Computers', link: '/guides/computers.md' },
{ 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: 'Compaction', link: '/guides/compaction.md' },
{ text: 'Scheduled Tasks', link: '/guides/schedule.md' },
{ text: 'Email', link: '/guides/email.md' },
{
text: 'Providers',
collapsed: true,
items: [
{ 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 Providers',
collapsed: true,
items: [
{ text: 'Built-in', link: '/integrations/providers/memory/builtin.md' },
{ text: 'Mem0', link: '/integrations/providers/memory/mem0.md' },
{ text: 'OpenViking', link: '/integrations/providers/memory/openviking.md' },
{ text: 'Overview', link: '/integrations/providers/memory/' },
],
},
{
text: 'TTS Providers',
collapsed: true,
items: [
{ text: 'Edge TTS', link: '/integrations/providers/tts/edge.md' },
{ text: 'Overview', link: '/integrations/providers/tts/' },
],
},
{ text: 'Overview', link: '/integrations/providers/' },
],
},
],
},
{
text: 'Use Cases',
items: [
{ text: 'Use Cases', link: '/guides/use-cases.md' },
],
},
]

export const en = {
'/guides/': [
{
text: 'Guides',
items: [
{ text: 'Overview', link: '/guides/' },
{ text: 'Quick Start', link: '/guides/quick-start.md' },
{ text: 'Preferences', link: '/guides/preferences.md' },
{ text: 'Bot', link: '/guides/bot.md' },
{ text: 'Sessions', link: '/guides/sessions.md' },
{ text: 'Agents / ACP', link: '/guides/acp.md' },
{ text: 'Access Control', link: '/guides/access.md' },
{ text: 'Workspace', link: '/guides/container.md' },
{ text: 'Computers', link: '/guides/computers.md' },
{ text: 'Browser / Computer Use', link: '/guides/browser-computer-use.md' },
{ text: 'Files', link: '/guides/files.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: 'Compaction', link: '/guides/compaction.md' },
{ text: 'Scheduled Tasks', link: '/guides/schedule.md' },
{ text: 'Email', link: '/guides/email.md' },
{ text: 'Slash Commands', link: '/guides/slash-commands.md' },
],
},
],
'/integrations/': [
{
text: 'Integrations',
items: [
{ text: 'Overview', link: '/integrations/' },
],
},
{
text: 'Channels',
items: [
{ text: 'Overview', link: '/integrations/channels/' },
{ text: 'Slack', link: '/integrations/channels/slack.md' },
{ text: 'Telegram', link: '/integrations/channels/telegram.md' },
{ text: 'Feishu (Lark)', link: '/integrations/channels/feishu.md' },
{ text: 'Discord', link: '/integrations/channels/discord.md' },
{ text: 'QQ', link: '/integrations/channels/qq.md' },
{ text: 'Matrix', link: '/integrations/channels/matrix.md' },
{ text: 'Misskey', link: '/integrations/channels/misskey.md' },
{ text: 'LINE', link: '/integrations/channels/line.md' },
{ text: 'DingTalk', link: '/integrations/channels/dingtalk.md' },
{ text: 'WeCom (WeWork)', link: '/integrations/channels/wecom.md' },
{ text: 'WeChat', link: '/integrations/channels/weixin.md' },
{ text: 'WeChat Official Account', link: '/integrations/channels/wechatoa.md' },
],
},
{
text: 'Providers',
items: [
{ text: 'Overview', link: '/integrations/providers/' },
{ 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 Providers',
items: [
{ text: 'Overview', link: '/integrations/providers/memory/' },
{ text: 'Built-in', link: '/integrations/providers/memory/builtin.md' },
{ text: 'Mem0', link: '/integrations/providers/memory/mem0.md' },
{ text: 'OpenViking', link: '/integrations/providers/memory/openviking.md' },
],
},
{
text: 'TTS Providers',
items: [
{ text: 'Overview', link: '/integrations/providers/tts/' },
{ text: 'Edge TTS', link: '/integrations/providers/tts/edge.md' },
],
},
],
'/self-hosted/': [
{
text: 'Self-hosted',
items: [
{ text: 'Overview', link: '/self-hosted/' },
{ text: 'Desktop', link: '/self-hosted/desktop.md' },
{ text: 'Server Deploy', link: '/self-hosted/docker.md' },
{ text: 'Workspace Backends', link: '/self-hosted/workspace-backends.md' },
],
},
],
'/guides/': references,
'/integrations/': references,
'/self-hosted/': references,
}
32 changes: 16 additions & 16 deletions docs/.vitepress/theme/components/DocsHome.vue
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,23 @@ const copy = computed(() => {
{
tone: 'guide',
icon: 'book',
title: '教程',
text: '学习如何创建机器人、管理会话并使用 Memoh 的核心功能。',
title: '入门指南',
text: '部署、添加模型、创建机器人、接入渠道,并掌握日常基础操作。',
href: '/zh/guides/',
},
{
tone: 'integration',
icon: 'plug',
title: '集成',
text: '连接渠道、模型、记忆、TTS 和网页搜索等外部能力。',
href: '/zh/integrations/',
title: '进阶教程',
text: '高级能力、自动化与外部提供方——智能体、Hooks、长期记忆等。',
href: '/zh/guides/',
},
{
tone: 'hosted',
icon: 'server',
title: '自托管',
text: '部署和运维开源版 Memoh,适合自建服务和本地运行。',
href: '/zh/self-hosted/',
title: '使用场景',
text: '组合多种功能解决实际问题的即用型示例。',
href: '/zh/guides/use-cases',
},
],
}
Expand All @@ -55,23 +55,23 @@ const copy = computed(() => {
{
tone: 'guide',
icon: 'book',
title: 'Guides',
text: 'Learn how to create bots, manage sessions, and use Memoh core features.',
title: 'Getting Started',
text: 'Deploy, add a model, create a bot, connect channels, and learn the day-to-day basics.',
href: '/guides/',
},
{
tone: 'integration',
icon: 'plug',
title: 'Integrations',
text: 'Connect channels, models, memory, TTS, web search, and other external capabilities.',
href: '/integrations/',
title: 'Advanced',
text: 'Capabilities, automation, and external providers — agents, hooks, memory, and more.',
href: '/guides/',
},
{
tone: 'hosted',
icon: 'server',
title: 'Self-hosted',
text: 'Deploy and operate open-source Memoh for your own servers or local runtime.',
href: '/self-hosted/',
title: 'Use Cases',
text: 'Ready-to-follow scenarios that combine features to solve real problems.',
href: '/guides/use-cases',
},
],
}
Expand Down
Loading