feat: improve feedback and App lifecycle reliability (#404)
Waiting feedback and tooltips now share consistent presentation lifecycles, while App shutdown and native-media operation failures stay within their owning session or output. This phase also consolidates the project standards and publishes searchable English/Chinese reader documentation alongside the homepage. Validation: repository hygiene and Markdown links; TypeScript, 971 Web tests and production build; website/documentation build; Go tests, vet and Windows/Linux builds with Windows capture checks; desktop/mobile UI and documentation review. Linux race, container and three-platform packaging checks run in the release pipeline. Physical macOS/Linux capture and broader network coverage remain outside this acceptance. The owner approved v1.4.0 publication. Existing empty-source, Windows URL-handler and public-invitation timeout reports remain tracked; this release makes no claim to resolve those device/network reports. The Windows capture-border request is next-phase work. ## Release notes ### 中文 这是一次以稳定性和交互一致性为重点的功能更新。等待与提示更有反馈，App 启动、原生分享和连接恢复的边界处理得到改善，使用与部署指南也有了统一的文档中心。 #### 新增与改进 - 欢迎语、等待短句和六类可轮换的标签页标题共用一致的显示规则。等待短句从一开始就出现，并在停留时轮换；明确的错误与操作提示保持固定。 - 房间准入等漫画采用更克制的小人物与循环动效。改进 tooltip 的定位与指向，减少对播放器的遮挡；状态、图标和文案保持相同含义。 - 新增中英文文档中心，提供搜索、手机目录、使用教程、问题排查与自部署指南。官网 FAQ 聚焦开始使用前的问题，详细排查统一进入文档中心。 #### 修复 - 使用 `--local` 启动不再清空已保存的 Piik 站点地址。 - 打开系统浏览器不再阻塞 App 的退出流程；改进临时公网邀请、终端和诊断导出在关闭时的清理及错误反馈。 - 单条原生媒体连接的操作失败不再被误判为整个会话的协议错误；重复停止分享保持幂等。 - 修复连接替换、转发停止和异常退出时的部分资源清理问题，避免迟到结果影响当前连接。 - Windows 原生采集中，单个输出的编码错误只结束对应输出；共享采集源本身的错误仍会结束分享。 #### 升级与已知边界 本次保持现有协议版本与配置格式。更新 App 或自托管 Server 后，重新打开页面即可使用对应的新界面。 个别设备的空窗口列表、Windows 浏览器启动异常，以及 Linux 编码输出的故障隔离仍在跟进。macOS/Linux 的物理采集和更广泛的公网网络场景仍需实机验证；本次不宣称这些问题已经解决，也不承诺所有网络都能直连。 ### English This feature update focuses on stability and consistent feedback. Waiting states are easier to follow, App startup and native sharing handle several failure cases more reliably, and the new documentation center brings usage and deployment guides together. #### New and improved - Welcome lines, waiting captions and six groups of rotating tab titles follow one presentation lifecycle. Waiting captions appear immediately and rotate while visible; actionable errors and instructions remain fixed. - Room-admission comics use restrained characters and looping motion. Tooltips point more accurately to their controls and interfere less with the player, with consistent meanings across illustrations, icons and copy. - A new English/Chinese documentation center includes search, mobile navigation, usage guides, troubleshooting and self-hosting. The homepage FAQ covers questions before getting started and links to the documentation for detailed help. #### Fixes - Starting with `--local` no longer clears a saved Piik site address. - Opening the system browser no longer blocks App shutdown. Temporary public invitations, the terminal and diagnostic exports handle cleanup and exit errors more consistently. - An operation failure on one native media connection no longer becomes a protocol failure for the entire session. Repeated stop-sharing requests are safe. - Fixed cleanup cases during connection replacement, relay shutdown and unexpected exits, preventing late results from affecting the current connection. - On Windows, an encoder failure for one native output stops that output only. A failure of the shared capture source still ends sharing. #### Updating and known limits Protocol versions and configuration formats are unchanged. After updating the App or your self-hosted Server, reopen the page to use its updated interface. Empty source lists on some devices, Windows browser-launch failures and Linux output-failure isolation remain under investigation. Physical macOS/Linux capture and broader public-network coverage still need device testing; this update does not claim to resolve those cases or guarantee a direct connection on every network.
This commit is contained in:
236 files changed
+8834
-2449
No files matched your search
+23
-17
@@ -2,6 +2,10 @@
|
||||
|
||||
[About Piik](../README.md) · [中文介绍](../README.zh-CN.md) · [中文上手指南](./guide/getting-started.zh-CN.md)
|
||||
|
||||
For using Piik, troubleshooting or self-hosting, start with the
|
||||
[reader documentation](./guide/README.md) · [中文文档中心](./guide/README.zh-CN.md).
|
||||
This page also indexes developer and maintainer references.
|
||||
|
||||
## Guides And References
|
||||
|
||||
| Task | Guide |
|
||||
@@ -9,15 +13,17 @@
|
||||
| Use Piik online | [Open the online site](https://demo.piik.tv) · [Online sharing guide](./guide/getting-started.md#use-piik-online) |
|
||||
| Watch a friend or share my first screen | [Getting started](./guide/getting-started.md) |
|
||||
| Choose an App mode or fix sound and connection trouble | [First-use help](./guide/getting-started.md#choose-an-app-mode) |
|
||||
| Page opens but video will not connect / 网页能打开，画面连不上 | [Connection troubleshooting](./guide/getting-started.md#when-video-will-not-connect) · [中文排查](./guide/getting-started.zh-CN.md#画面连接不上) |
|
||||
| Run Piik App, check platform requirements, or build a package | [App guide](../cmd/piik-app/README.md) · [中文 App 指南](../cmd/piik-app/README.zh-CN.md) |
|
||||
| Try or change the source code | [Run from source](#run-from-source) |
|
||||
| Find a directory or the module responsible for a behavior | [Repository layout and module map](./reference/engineering.md#repository-layout) |
|
||||
| Find a directory or the module responsible for a behavior | [Repository layout and module map](./standards/engineering.md#repository-layout) |
|
||||
| Find the shared product, design and lifecycle rules | [Standards index](./standards/README.md) |
|
||||
| Host a site for my group | [Self-hosting](./operations/self-hosting.md) · [中文部署](./operations/self-hosting.zh-CN.md) |
|
||||
| Keep a server running with systemd or Docker | [Service management](./operations/service-management.md) · [中文服务管理](./operations/service-management.zh-CN.md) |
|
||||
| Set passwords, ports, or room storage | [Configuration](./reference/configuration.md) |
|
||||
| Set passwords, ports, or room storage | [Configuration](./standards/configuration.md) |
|
||||
| Update my server | [Server updates](./operations/self-hosting.md#keep-it-running-and-update) |
|
||||
| Build, publish or recover a maintained release | [Maintainer release tooling](./deployment.md) |
|
||||
| Send a useful bug report | [Diagnostics and export](./reference/configuration.md#diagnostics) |
|
||||
| Send a useful bug report | [Diagnostics and export](./standards/configuration.md#diagnostics) |
|
||||
| Translate Piik or improve wording | [Translation guide](./guide/translating.md) · [中文翻译教程](./guide/translating.zh-CN.md) |
|
||||
| Check release and platform readiness | [Current status](./status.md) |
|
||||
|
||||
@@ -57,7 +63,7 @@ The fixed Windows executable path avoids repeated firewall prompts from `go run`
|
||||
Open [localhost:8787](http://localhost:8787), start sharing, and open the invitation
|
||||
in another browser tab to try watching. This localhost invitation stays on your
|
||||
computer; remote invitations need a reachable origin as described in
|
||||
[configuration](./reference/configuration.md).
|
||||
[configuration](./standards/configuration.md).
|
||||
Browser capture requires `localhost` or HTTPS.
|
||||
|
||||
For the self-contained App, follow [App development](../cmd/piik-app/README.md#development)
|
||||
@@ -71,25 +77,25 @@ The main verification commands are:
|
||||
|
||||
```sh
|
||||
npm run check
|
||||
npm run check:client
|
||||
npm run check:go
|
||||
```
|
||||
|
||||
Use the [naming and copy guide](./reference/naming.md) for product names,
|
||||
Use the [naming and copy guide](./standards/naming.md) for product names,
|
||||
commands, role labels and Chinese/English voice.
|
||||
Piik-owned code uses [MIT](../LICENSE); see the
|
||||
[licensing guide](../licenses/README.md) for third-party components.
|
||||
|
||||
For the public website, see the [introduction design](./design/public-introduction.md)
|
||||
For the public website, see the [introduction design](./standards/public-introduction.md)
|
||||
and [website preview and publishing](./operations/website.md).
|
||||
|
||||
## Understand the product
|
||||
|
||||
| Topic | Its reference |
|
||||
| --- | --- |
|
||||
| Invitations, room codes and passwords | [Rooms and access](./product/rooms-access.md) |
|
||||
| How viewers connect | [Routing and transport](./product/routing-transport.md) |
|
||||
| Screen capture, quality controls and sound | [Media quality](./product/media-quality.md) |
|
||||
| Host and viewer behavior | [Presentation and lifecycle](./product/presentation-lifecycle.md) |
|
||||
| Invitations, room codes and passwords | [Rooms and access](./standards/rooms-access.md) |
|
||||
| How viewers connect | [Routing and transport](./standards/routing-transport.md) |
|
||||
| Screen capture, quality controls and sound | [Media quality](./standards/media-quality.md) |
|
||||
| Host and viewer behavior | [Presentation and lifecycle](./standards/presentation-lifecycle.md) |
|
||||
| Why a design was chosen | [Architecture decisions](./adr/) |
|
||||
| Measurements and platform limits | [Research](./research/) and [verification status](./verification-status.md) |
|
||||
|
||||
@@ -97,13 +103,13 @@ and [website preview and publishing](./operations/website.md).
|
||||
|
||||
| When changing… | Follow this owner |
|
||||
| --- | --- |
|
||||
| Module responsibilities or interfaces | [Engineering and contract map](./reference/engineering.md) |
|
||||
| Product/tool names, role labels or copy | [Naming and copy](./reference/naming.md) |
|
||||
| UI colour, illustration, motion or layout | [Visual language](./design/visual-language.md) |
|
||||
| Overlays, titles or state indicators | [Media status](./design/media-status.md) |
|
||||
| Releases, protocols or stored formats | [Versions and compatibility](./reference/versioning.md) |
|
||||
| Module responsibilities or interfaces | [Engineering and contract map](./standards/engineering.md) |
|
||||
| Product/tool names, role labels or copy | [Naming and copy](./standards/naming.md) |
|
||||
| UI colour, illustration, motion or layout | [Visual language](./standards/visual-language.md) |
|
||||
| Overlays, titles or state indicators | [Media status](./standards/media-status.md) |
|
||||
| Releases, protocols or stored formats | [Versions and compatibility](./standards/versioning.md) |
|
||||
| Main protection or automatic publishing | [GitHub operations](./operations/github.md) |
|
||||
| Documentation or a duplicated rule | [Documentation ownership](./maintenance.md) |
|
||||
| Documentation or a duplicated rule | [Documentation ownership](./standards/documentation.md) |
|
||||
| Checks, PRs, integration or cleanup | [Contributing](../CONTRIBUTING.md) |
|
||||
|
||||
For ongoing work, use [TODO](./todo.md). [Project memory](./project-memory.md)
|
||||
|
||||
Reference in new issue
Block a user