Merge pull request #698 from MoYingJi/pr/d

docs: 更新文档

Author: imsyy

README.md

@@ -17,38 +17,6 @@
 
 ![main](/screenshots/SPlayer.jpg)
 
-# 目录
-
-<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
-
-<!-- code_chunk_output -->
-
-- [目录](#目录)
-  - [说明](#说明)
-    - [严肃警告](#严肃警告)
-  - [💬 交流群](#-交流群)
-  - [👀 Demo](#-demo)
-  - [🎉 功能](#-功能)
-  - [🖼️ 界面展示](#️-界面展示)
-  - [📦️ 获取](#️-获取)
-    - [二进制安装方案](#二进制安装方案)
-      - [稳定版](#稳定版)
-      - [开发版](#开发版)
-    - [自行部署方案](#自行部署方案)
-      - [⚙️ Docker 部署](#️-docker-部署)
-        - [本地构建](#本地构建)
-        - [在线部署](#在线部署)
-      - [⚙️ Vercel 部署](#️-vercel-部署)
-      - [⚙️ 服务器部署](#️-服务器部署)
-      - [⚙️ 本地部署](#️-本地部署)
-  - [😘 鸣谢](#-鸣谢)
-  - [🗺️ 贡献者联盟](#️-贡献者联盟)
-  - [📢 免责声明](#-免责声明)
-  - [📜 开源许可](#-开源许可)
-  - [⭐ Star History](#-star-history)
-
-<!-- /code_chunk_output -->
-
 ## 说明
 
 ![提示](/screenshots/gitcodes.png)
@@ -64,17 +32,17 @@
 > - 感谢您的尊重与理解
 
 - 本项目采用 [Vue 3](https://cn.vuejs.org/) + [TypeScript](https://www.typescriptlang.org/) + [Naïve UI](https://www.naiveui.com/) + [Electron](https://www.electronjs.org/zh/docs/latest/) 开发
-- 支持网页端与客户端，由于设备有限，目前仅适配 `Win`，其他平台可自行解决兼容性后进行构建
-- 仅对移动端做了基础适配，**不保证功能全部可用**
+- 支持网页端与客户端，由于设备有限，目前仅保证 Windows 系统的适配，其他平台如遇问题可以提 Issue 或自行解决后选择提 PR
+<!-- - 仅对移动端做了基础适配，**不保证功能全部可用** -->
 
-  > 请注意，本程序不打算开发移动端，也不会对移动端进行完美适配，仅保证基础可用性
+<!--  > 请注意，本程序不打算开发移动端，也不会对移动端进行完美适配，仅保证基础可用性 -->
 
 - 欢迎各位大佬 `Star` 😍
 
 ## 💬 交流群
 
 <a href="https://qm.qq.com/cgi-bin/qm/qr?k=2-cVSf1bE0AvAehCib00qFEFdUvPaJ_k&jump_from=webapi&authKey=1NEhib9+GsmsXVo2rCc0IbRaVHeeRXJJ0gbsyKDcIwDdAzYySOubkFCvkV32+7Cw" target="_blank">
-<img src="screenshots/welcome.png" alt="交流群" width="300" />
+  <img src="screenshots/welcome.png" alt="交流群" width="300" />
 </a>
 
 ## 👀 Demo
@@ -172,9 +140,7 @@
 
 #### 开发版
 
-可以通过 `GitHub Actions` 工作流获取最新的开发版，目前开发版仅提供 `Win` 版本
-
-> 如需其他平台的开发版构建，请自行 Fork 本项目并参考 `.github/workflows/release.yml` 创建相应的工作流
+可以通过 GitHub Actions 工作流获取最新的开发版
 
 [Dev Workflow](https://github.com/imsyy/SPlayer/actions/workflows/dev.yml)
 
@@ -210,13 +176,13 @@ docker pull ghcr.io/imsyy/splayer:latest
 docker run -d --name SPlayer -p 25884:25884 imsyy/splayer:latest
 ```
 
-以上步骤成功后，将会在本地 [localhost: 25884](http://localhost:25884/) 启动，如需更换端口，请自行修改命令行中的端口号
+以上步骤成功后，将会在本地 [localhost:25884](http://localhost:25884/) 启动，如需更换端口，请自行修改命令行中的第一个端口号
 
 #### ⚙️ Vercel 部署
 
 > 其他部署平台大致相同，在此不做说明
 
-1. 本程序依赖 [NeteaseCloudMusicApi](https://github.com/Binaryify/NeteaseCloudMusicApi) 运行，请确保您已成功部署该项目，并成功取得在线访问地址
+1. 本程序依赖 [NeteaseCloudMusicApi](https://github.com/Binaryify/NeteaseCloudMusicApi) 运行，请确保您已成功部署该项目或兼容的项目，并成功取得在线访问地址
 2. 点击本仓库右上角的 `Fork`，复制本仓库到你的 `GitHub` 账号
 3. 复制 `/.env.example` 文件并重命名为 `/.env`
 4. 将 `.env` 文件中的 `VITE_API_URL` 改为第一步得到的 API 地址
@@ -282,7 +248,7 @@ docker run -d --name SPlayer -p 25884:25884 imsyy/splayer:latest
    | ------------------ | -------- |
    | `pnpm build:win`   | Windows  |
    | `pnpm build:linux` | Linux    |
-   | `pnpm build:mac`   | MacOS    |
+   | `pnpm build:mac`   | macOS    |
 
 ## 😘 鸣谢
 
@@ -302,15 +268,11 @@ docker run -d --name SPlayer -p 25884:25884 imsyy/splayer:latest
 感谢以下所有贡献者 💖
 
 <a href="https://github.com/imsyy/SPlayer/graphs/contributors" target="_blank" rel="noopener">
-  <picture>
-    <source media="(prefers-color-scheme: dark)" 
-            srcset="https://contrib.rocks/image?repo=imsyy/SPlayer&max=30&anon=1&theme=dark&v=1">
-    <img src="https://contrib.rocks/image?repo=imsyy/SPlayer&max=30&anon=1&v=1" 
-         alt="SPlayer 项目贡献者" 
-         width="650" 
-         loading="lazy"
-         style="border-radius: 10px; transition: transform 0.2s ease;">
-  </picture>
+  <img src="https://contrib.rocks/image?repo=imsyy/SPlayer&max=30&anon=1&v=1"
+    alt="SPlayer 项目贡献者"
+    width="650"
+    loading="lazy"
+  />
 </a>
 
 ## 📢 免责声明
@@ -334,8 +296,6 @@ docker run -d --name SPlayer -p 25884:25884 imsyy/splayer:latest
   5. **社区参与：** 欢迎社区的参与和贡献，我们鼓励开发者一同改进和维护本项目
   6. **许可证链接：** 请阅读 [GNU Affero General Public License (AGPL-3.0)](https://www.gnu.org/licenses/agpl-3.0.html) 了解更多详情
 
-
-
 ## ⭐ Star History
 
 [![Star History Chart](https://api.star-history.com/svg?repos=imsyy/SPlayer&type=Date)](https://star-history.com/#imsyy/SPlayer&Date)

docs/api.md

@@ -371,8 +371,6 @@ print(response.json())
 
 ---
 
-
-
 ## 注意事项
 
 1. 所有接口仅在应用程序运行时可用

docs/contributing.md

@@ -35,7 +35,7 @@
 
 ## 开发环境搭建
 
-请参考 [使用指南](/guide.html#本地开发环境) 完成以下准备工作：
+请参考 [使用指南](/guide.html#🛠-本地开发环境) 完成以下准备工作：
 
 1. 安装 Node.js (v18+)
 2. 安装 pnpm
@@ -152,14 +152,15 @@ git push origin feature/your-feature-name
 2. 点击 **Compare & pull request** 按钮
 3. 填写 PR 标题和描述：
    - 清晰描述更改内容
-   - 关联相关 Issue（如有）：`Closes #123`
+   - 关联相关 Issue（如有）：`Closes #123`（详细信息可查看 [GitHub 文档](https://docs.github.com/zh/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue)）
    - 提供测试方法或截图
 4. 点击 **Create pull request**
 
 ### 8. 代码审查
 
+- AI 会对 PR 进行初步审核（AI 有时会挑刺，只改你觉得有必要的即可）
 - 维护者可能会提出修改建议
-- 根据反馈进行修改并推送更新
+- 根据反馈进行修改并推送更新，你也可以选择说服维护者为什么你是对的
 - PR 合并后，可删除功能分支
 
 ```bash
@@ -184,7 +185,7 @@ pnpm lint
 pnpm format
 ```
 
-提交前请确保代码通过规范检查。
+提交前请确保您的代码通过规范检查。
 
 ### 目录结构
 

docs/guide.md

@@ -12,7 +12,7 @@
 | ------- | --------------------------------- |
 | Windows | `.exe` (安装版) / `.zip` (便携版) |
 | macOS   | `.dmg`                            |
-| Linux   | `.AppImage` / `.deb`              |
+| Linux   | `.AppImage` / `.deb` / ...        |
 
 ### Docker 部署 (仅 Web 版)
 
@@ -185,10 +185,6 @@ pnpm build:win -- --x64 --arm64
 - **Prettier**: 代码格式化
 - **rust-analyzer**: Rust 语言支持 (开发原生模块时)
 
-#### 配置文件
-
-项目已配置 `.vscode/settings.json`，打开项目时 VS Code 会自动应用推荐设置。
-
 ## ⚠️ 重要提示
 
 ::: warning 许可协议

docs/troubleshooting/debug.md

@@ -27,14 +27,13 @@
 | ------- | --------------------------------------------- |
 | Windows | `%APPDATA%\SPlayer\logs\`                     |
 | macOS   | `~/Library/Application Support/SPlayer/logs/` |
-| Linux   | `~/.config/SPlayer/logs/`                     |
+| Linux   | `$XDG_CONFIG_HOME/SPlayer/logs/`              |
 
-开发环境日志：`%APPDATA%\SPlayer\logs\dev\`
+开发环境日志：`%APPDATA%\SPlayer\logs\dev\`（在原日志目录的 `dev` 子文件夹下）
 
 原生模块日志：
 
 - SMTC 日志：`%APPDATA%\SPlayer\logs\smtc\`
-- Discord RPC 日志：`%APPDATA%\SPlayer\logs\discord\`
 
 ## 常见错误类型
 
@@ -90,6 +89,9 @@ rd /s /q "%APPDATA%\SPlayer\Cache"
 
 # 清除应用缓存（macOS）
 rm -rf ~/Library/Application\ Support/SPlayer/Cache
+
+# 清除应用缓存（Linux）
+rm -rf "${XDG_CONFIG_HOME:-$HOME/.config}/SPlayer/Cache"
 ```
 
 ## 收集调试信息
@@ -98,7 +100,7 @@ rm -rf ~/Library/Application\ Support/SPlayer/Cache
 
 1. **系统信息**
    - 操作系统版本
-   - SPlayer 版本
+   - SPlayer 版本（如果是开发版本，还要带上 Commit ID）
    - Node.js 版本（如果是开发环境）
 
 2. **错误信息**
@@ -125,7 +127,7 @@ rd /s /q "%APPDATA%\SPlayer"
 rm -rf ~/Library/Application\ Support/SPlayer
 
 # Linux
-rm -rf ~/.config/SPlayer
+rm -rf "${XDG_CONFIG_HOME:-$HOME/.config}/SPlayer"
 ```
 
 重置后重新启动应用并登录即可。