Skip to content

docs: 更新文档 - #143

Merged
imsyy merged 1 commit into
SPlayer-Dev:devfrom
MoYingJi:pr/docs
Aug 10, 2026
Merged

docs: 更新文档#143
imsyy merged 1 commit into
SPlayer-Dev:devfrom
MoYingJi:pr/docs

Conversation

@MoYingJi

@MoYingJi MoYingJi commented Aug 8, 2026

Copy link
Copy Markdown
Collaborator

改动类型

  • 新功能(feat)
  • 缺陷修复(fix)
  • 重构 / 优化(不改变对外行为)
  • 文档(docs)
  • 其他(请在「改动说明」中注明)

是否包含破坏性变更

  • 是(请在「改动说明」中详细描述)

改动说明

  • Wayland 相关内容
  • 文档的体验(editLink 和为 summary 设置 cursor: pointer;
  • Linux 安装运行的命令统一放到一个地方
  • 修正内容(现在并不能指定架构交叉编译,这样会导致编译出的原生模块不是目标架构的。非开发环境无法通过快捷键打开开发者功能)
  • Issue 模板

自查清单

  • 本 PR 只包含一个主要功能 / 修复,没有夹带无关改动
  • 已在本地完整测试通过;AI 生成的代码同样自行测试并审阅过,未做未经验证的提交
  • 已运行 pnpm format,并确认 pnpm typecheckpnpm lint 通过
  • 改动涉及原生模块时已 pnpm build:native 验证;未手写 native/*/index.d.ts
  • 已向 dev 分支提交

@MoYingJi
MoYingJi marked this pull request as ready for review August 9, 2026 15:58
Copilot AI balanced review requested due to automatic review settings August 9, 2026 15:58

Copilot AI 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.

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**)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

我并没有显式设置 GlobalShortcutsPortal 特性,但它确实给我弹了,而且生效了(KDE Plasma Wayland)

Comment thread docs/download.md Outdated
Copilot AI review requested due to automatic review settings August 9, 2026 16:15

Copilot AI 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.

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**)

@imsyy
imsyy merged commit 67169d2 into SPlayer-Dev:dev Aug 10, 2026
3 checks passed
@MoYingJi
MoYingJi deleted the pr/docs branch August 10, 2026 11:33
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.

3 participants