docs: 更新文档 - #143
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
本 PR 集中更新文档体验、Linux/Wayland 使用说明及 Issue 模板。
Changes:
- 补充 Wayland、全局快捷键及 Linux 安装说明。
- 修正构建与开发者工具文档。
- 优化文档编辑入口和交互样式。
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
README.zh-CN.md |
修正中文构建说明并移除重复安装步骤。 |
README.md |
同步英文构建说明。 |
docs/troubleshooting/wayland.md |
扩充 Wayland 排障和快捷键说明。 |
docs/troubleshooting/debug.md |
更新开发者工具打开方式。 |
docs/download.md |
集中整理 Linux 安装命令。 |
docs/.vitepress/theme/custom.css |
为折叠摘要增加指针样式。 |
docs/.vitepress/config.ts |
调整页面源码链接。 |
.github/ISSUE_TEMPLATE/bug.yml |
优化缺陷报告信息收集。 |
Suppressed comments (2)
docs/troubleshooting/wayland.md:138
- 必修:实现并没有把注册限制在启动阶段。修改绑定后会经
setBinding()→writeConfig()→applyAll()立即重新调用globalShortcut.register(),因此要求用户每次修改后都重启会造成误导。应说明修改会立即重新注册,仅把重启作为授权请求未出现时的排障步骤。
> [!TIP]
>
> 授权请求仅在开启应用时弹出。所以每次修改全局快捷键后,都需要重新启动应用以触发授权请求。
docs/download.md:42
- 必修:
rpm -i不会解析依赖,而且同一条命令不能准确覆盖表中列出的 Fedora/RHEL 与 openSUSE。请分别使用发行版包管理器安装本地包,以便自动处理依赖。
# rpm
sudo rpm -i ./splayer-next-*.rpm
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+124
to
+126
| 在原生 Wayland 下,Electron 的全局快捷键通过 `xdg-desktop-portal` 实现。 | ||
|
|
||
| 打开应用时,若有新的未申请的全局快捷键,应该会弹出授权请求,点击确定即可。也可以在系统设置中查看 SPlayer-Next 是否有注册全局快捷键(在 KDE Plasma Wayland 中是 **系统设置 → 键盘 → 快捷键 → SPlayer-Next**) |
Collaborator
Author
There was a problem hiding this comment.
我并没有显式设置 GlobalShortcutsPortal 特性,但它确实给我弹了,而且生效了(KDE Plasma Wayland)
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 8 changed files in this pull request and generated no new comments.
Suppressed comments (1)
docs/troubleshooting/wayland.md:126
- 必修:这里描述的 Portal 流程在当前应用中不会生效。Electron 要求在
ready前通过app.commandLine.appendSwitch("enable-features", "GlobalShortcutsPortal")显式启用该实现,但electron/main/core/index.ts:39-42目前只配置了disable-features。因此 Wayland 用户不会看到下文所述的授权请求。请同步启用该特性,或删除这段尚未生效的操作说明。
在原生 Wayland 下,Electron 的全局快捷键通过 `xdg-desktop-portal` 实现。
打开应用时,若有新的未申请的全局快捷键,应该会弹出授权请求,点击确定即可。也可以在系统设置中查看 SPlayer-Next 是否有注册全局快捷键(在 KDE Plasma Wayland 中是 **系统设置 → 键盘 → 快捷键 → SPlayer-Next**)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
改动类型
是否包含破坏性变更
改动说明
editLink和为summary设置cursor: pointer;)自查清单
pnpm format,并确认pnpm typecheck、pnpm lint通过pnpm build:native验证;未手写native/*/index.d.tsdev分支提交