Skip to content

docs(peer): 更新多连接用户手册与交互型 Peer 推荐 - #43

Merged
xiaoland merged 2 commits into
mainfrom
feat/peer-connections-manual
Oct 26, 2026
Merged

xiaoland merged 2 commits into
mainfrom
feat/peer-connections-manual

Conversation

@xiaoland

@xiaoland xiaoland commented Oct 25, 2026 •

Copy link
Copy Markdown
Member

目的与范围

配合 Web、Mac 与浏览器扩展的多连接实现,补齐用户如何保存、切换和恢复连接的说明,并澄清这一能力的适用范围。

  • PRD 推荐 Peer 支持本机命名连接;通常由直接与用户交互的 Web、桌面应用和浏览器扩展提供。固定服务于一个信息库的 impl-py 服务器可以只使用部署配置;这一例外不影响同仓 CLI 的本机命名连接。
  • 新增 User Guide 的 Manage Connections,覆盖 Web、Mac、浏览器扩展与 CLI;更新首次连接页、CLI 入口和侧栏。网站沿用现有英文 locale。
  • 区分 PostgREST、原生 PostgreSQL 与 API 接入,以及 JWT secret 和 Keychain 数据库密码;说明本地保存、身份复用、Web 全列表备份与导入替换。
  • 明确切换不搬迁信息库、不改投已绑定目标的待办或目录监视;Web 检查失败保留已保存选择,但停止的后台参与可能需要 Retry。
  • 开发者架构页链接权威 PRD,移除首次连接页已经过时的 Settings 截图引用。

配套实现与交付顺序

文档直接基于 main,没有 Git 父子依赖。操作页描述提供多连接功能的版本,明确 Mac 当前为开发构建及其数据库支持前提。Web 操作说明随配套功能交付后发布,避免正式网站先于应用提供新控件。

没有新增服务端功能、数据库迁移或 Spoke 子模块指针更新;保留各实现 PR 原有的共享合同基底。

验证

  • pnpm --dir website install --frozen-lockfile 与 pnpm --dir website check 通过,包含格式、生产构建及内部死链检查。
  • 核对 Web/Mac/扩展实际控件名称与 CLI 命令定义。
  • 使用 agent-browser 的独立本机会话查看生产构建:1440px 桌面浅色和 390px 窄屏阅读正常,正文无横向溢出,命令块独立横向滚动。
  • 首次连接页的 Web/CLI 指引切换正常,没有页面脚本错误;临时浏览器会话与预览服务已关闭。
  • 2026-10-26 补明 Mac 数据库前提后,网站检查本地及 CI 再次通过。Web #167 已合并,其 main Pages 交付成功后再合并本文档。

风险与回退

本次仅改文档与导航,没有重新执行多库功能验收。主要风险是文档早于对应应用版本发布;Web 功能交付后再合并本文档,Mac 开发构建和数据库前提另有明确说明。合并会触发既有网站部署。回退此文档提交可恢复原导航和说明。

父 PR:无。子 PR:无。

- 说明 Web、Mac、浏览器扩展与 CLI 的保存和切换操作
- 明确交互型 Peer 的推荐与固定服务进程的例外
- 保留各入口协议、凭据与已有任务目标边界
- 链接原生 Capture 数据库支持,避免误以为现有部署已兼容
@xiaoland
xiaoland merged commit 7936aa2 into main Oct 26, 2026
2 checks passed

This branch was successfully deployed

1 active deployment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant