Skip to content

docs: align protocol and session docs with dev - #171

Open
Leon-Dicaprio wants to merge 3 commits into
1024XEngineer:devfrom
Leon-Dicaprio:docs/p0-protocol-design
Open

docs: align protocol and session docs with dev#171
Leon-Dicaprio wants to merge 3 commits into
1024XEngineer:devfrom
Leon-Dicaprio:docs/p0-protocol-design

Conversation

@Leon-Dicaprio

@Leon-Dicaprio Leon-Dicaprio commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add docs/LINGOW_PROTOCOL_DESIGN.md for the current Lingow protocol design.
  • Align the protocol design with the latest dev contracts.
  • Update services/api/sessions/README.md so it reflects the current Sessions implementation, public routes, realtime adapter ownership mapping, production composition, and the remaining Runtime Failure transport boundary.

Validation

  • git fetch --all --prune
  • git rebase upstream/dev
  • git diff --check
  • README stale-text grep for outdated implementation-status language

Notes

This PR targets 1024XEngineer/xe6-tsy:dev from Leon-Dicaprio/xe6-tsy:docs/p0-protocol-design. The local working tree still has an untracked .worktrees/ directory that was not included.

@github-actions

github-actions Bot commented Jul 31, 2026

Copy link
Copy Markdown

Go coverage

Scope Current Baseline Delta
packages/contracts 84.2% 84.2% +0.0%
services/api 55.7% 55.6% +0.0%
services/realtime-audio 78.4% 78.4% +0.0%
Total 64.4% 64.4% +0.0%

Base branch: dev · Commit: 31f8c2b · Test workflow run

@fennoai fennoai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Summary

Found three protocol inconsistencies that could cause incompatible clients or spoofed actor metadata. See the inline findings.

View job run

Comment thread docs/LINGOW_PROTOCOL_DESIGN.md Outdated
Comment thread docs/LINGOW_PROTOCOL_DESIGN.md Outdated
Comment thread docs/LINGOW_PROTOCOL_DESIGN.md Outdated
添加 Lingow 跨模块协议设计文档,覆盖 REST/OpenAPI、会话、Realtime、WebRTC、DataChannel 事件、错误码及兼容性安全约束。
@Leon-Dicaprio
Leon-Dicaprio force-pushed the docs/p0-protocol-design branch from 046965c to 31f8c2b Compare August 4, 2026 06:26
@Leon-Dicaprio Leon-Dicaprio changed the title docs: add Lingow protocol design docs: align protocol and session docs with dev Aug 4, 2026

@Jerry-Yu-TeslaCoil Jerry-Yu-TeslaCoil left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这是纯文档 PR(协议设计 + sessions README),CI 全绿。对照过现有 contracts/实现后,早期 bot 提的字段不一致(session_id、started_by 身份约束、speaker_label_snapshot)在当前 HEAD 已对齐,没发现会误导客户端或造成错误实现的大问题。

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.

2 participants