Conversation
Walkthrough本次变更以文档修订为主:大面积删除行尾多余空格、少量标点和大小写修正;Deluge 文档(中/英)从占位符扩展为详细安装与配置指南;Docker 示例中将时区由 UTC 改为 Asia/Shanghai 并更新 Docker CLI 示例。未改动代码或导出实体。 Changes
Sequence Diagram(s)(变更以文档与示例更新为主,不涉及控制流或新功能,不生成序列图。) Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 分钟 Possibly related PRs
Suggested labels
Suggested reviewers
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (10)
i18n/en/docusaurus-plugin-content-docs/current/module/multi-dial.md (1)
3-3: 可考虑微调措辞以减少冗余LanguageTool 提示 “a large number of” 略显累赘,可按需改为 “many” 或具体数字以提升简洁度,纯属可选。
i18n/en/docusaurus-plugin-content-docs/current/module/active-monitoring.md (2)
3-4: “Peers data” 建议改为 “peer data”
英语习惯上使用不可数名词 peer data,去掉复数s可提升专业度。
6-6: “EMMC” 建议写作 “eMMC”
业界惯例小写首字母,保持与官方缩写一致。docs/faq.md (1)
15-17: 排版清理 OK,但存在轻微用词瑕疵
行尾空格已移除无异议,但句子「因此正确的设置网络模式…」建议改为「因此正确地设置网络模式…」以符合语法。docs/downloader/BitComet.md (1)
54-56: 列表项断行格式建议
当前两行实际属于一个列表项,Markdown 渲染时可能被拆分为两段。可考虑合并以保持列表连贯:-2. 关闭远程访问速度限制。 - (如果使用的是较旧版本)找到`network.ignore_remote_access_in_speed_limit`... +2. 关闭远程访问速度限制。(如果使用的是较旧版本)找到 `network.ignore_remote_access_in_speed_limit`...docs/misc/json-engine.md (1)
44-48: 统一「if 条件」的写法,避免前后不一致Line 44 写作“if条件”,Line 47 又写作“if 条件”,两处空格处理不一致,影响阅读体验。建议二选一并保持全篇统一(常见写法为“if 条件”)。
i18n/en/docusaurus-plugin-content-docs/current/downloader/Deluge.md (2)
9-11: 修正英文语法,提升可读性当前句子:
“All downloaders that deploy in Docker MUST use host network mode to make sure downloader can get correct incoming connection IP address, bridge will break it and not supported. PeerBanHelper may not working if you downloader not in correct network mode.”建议修改:
-All downloaders that deploy in Docker MUST use host network mode to make sure downloader can get correct incoming connection IP address, bridge will break it and not supported. PeerBanHelper may not working if you downloader not in correct network mode. +All downloaders deployed in Docker MUST run in host network mode to ensure they obtain the correct incoming connection IP address. Bridge mode is not supported. PeerBanHelper may not work if your downloader is not in the correct network mode.
17-18: 超链接缺少显式协议,Docusaurus 可能无法正确解析为保险起见,请将纯相对链接替换为完整 URL,避免在不同部署环境下解析失败:
-First, you need to download the Deluge adapter: [PBH-BTN/PBH-Adapter-Deluge](https://github.com/PBH-BTN/PBH-Adapter-Deluge/releases). Please select the plugin Egg file that matches your Deluge version for download. If there are no special instructions, please download the latest version. +First, download the Deluge adapter from [PBH-BTN/PBH-Adapter-Deluge](https://github.com/PBH-BTN/PBH-Adapter-Deluge/releases). Select the plugin egg file matching your Deluge version; if unsure, use the latest release.docs/downloader/Deluge.md (2)
9-11: 语义表述略显生硬,可调整为更自然的中文-所有部署在 Docker 中的下载器,不得使用 bridge 桥接网络模式,必须使用 host 网络模式,以使下载器能够获取正确的 Peer 入站地址,否则 PeerBanHelper 将完全不会工作! +所有在 Docker 中部署的下载器必须使用 host 网络模式,否则无法获取正确的 Peer 入站 IP,PeerBanHelper 将无法正常工作。
33-35: 图片 alt 文本拼写错误
![ste4p]拼写应为step4,便于读屏软件识别:-  + 
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (5)
docs/downloader/assets/Deluge-step1.pngis excluded by!**/*.pngdocs/downloader/assets/Deluge-step2.pngis excluded by!**/*.pngdocs/downloader/assets/Deluge-step3.pngis excluded by!**/*.pngdocs/downloader/assets/Deluge-step4.pngis excluded by!**/*.pngdocs/downloader/assets/Deluge-step5.pngis excluded by!**/*.png
📒 Files selected for processing (35)
docs/btn/connect.md(1 hunks)docs/downloader/BiglyBT.md(1 hunks)docs/downloader/BitComet.md(3 hunks)docs/downloader/Deluge.md(1 hunks)docs/downloader/Transmission.md(2 hunks)docs/downloader/qBittorrent.md(1 hunks)docs/downloader/qBittorrentEE.md(2 hunks)docs/faq.md(1 hunks)docs/intro.md(1 hunks)docs/misc/json-engine.md(1 hunks)docs/module/client-name.md(1 hunks)docs/module/expression-engine.md(2 hunks)docs/module/ip-address-blocker-rules.md(1 hunks)docs/module/ip-address-blocker.md(2 hunks)docs/module/peer-id.md(1 hunks)docs/module/progress-cheat-blocker.md(2 hunks)docs/network/http-server.md(1 hunks)docs/network/proxy-server.md(1 hunks)docs/statistic/charts.md(1 hunks)i18n/en/docusaurus-plugin-content-docs/current/downloader/BiglyBT.md(1 hunks)i18n/en/docusaurus-plugin-content-docs/current/downloader/BitComet.md(3 hunks)i18n/en/docusaurus-plugin-content-docs/current/downloader/Deluge.md(1 hunks)i18n/en/docusaurus-plugin-content-docs/current/downloader/Transmission.md(2 hunks)i18n/en/docusaurus-plugin-content-docs/current/downloader/qBittorrent.md(1 hunks)i18n/en/docusaurus-plugin-content-docs/current/downloader/qBittorrentEE.md(1 hunks)i18n/en/docusaurus-plugin-content-docs/current/faq.md(1 hunks)i18n/en/docusaurus-plugin-content-docs/current/module/active-monitoring.md(1 hunks)i18n/en/docusaurus-plugin-content-docs/current/module/auto-range-ban.md(1 hunks)i18n/en/docusaurus-plugin-content-docs/current/module/client-name.md(1 hunks)i18n/en/docusaurus-plugin-content-docs/current/module/expression-engine.md(1 hunks)i18n/en/docusaurus-plugin-content-docs/current/module/ip-address-blocker-rules.md(1 hunks)i18n/en/docusaurus-plugin-content-docs/current/module/ip-address-blocker.md(2 hunks)i18n/en/docusaurus-plugin-content-docs/current/module/multi-dial.md(1 hunks)i18n/en/docusaurus-plugin-content-docs/current/platform/Windows.md(1 hunks)i18n/en/docusaurus-plugin-content-docs/current/statistic/charts.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/module/ip-address-blocker.md
[uncategorized] ~30-~30: 数词与名词之间一般应存在量词,可能缺少量词。
Context: ...ions 国家/地区黑名单。可以输入一个或者多个 ISO 3166-1 国家二字母码。需...
(wa5)
i18n/en/docusaurus-plugin-content-docs/current/module/multi-dial.md
[style] ~3-~3: To reduce wordiness, try specifying a number or using “many” or “numerous” instead.
Context: ...g Blocker Some malicious users acquire a large number of IP addresses from the same subnet by us...
(LARGE_NUMBER_OF)
docs/faq.md
[uncategorized] ~18-~18: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:正确"地"设置
Context: ...并不推荐。一旦你这样做,PBH 将会 错误地封禁所有的入站连接,因此正确的设置网络模式是非常必要的。 某些 IP 转发工具,如 Lucky, FRP 等...
(wb4)
🔇 Additional comments (39)
i18n/en/docusaurus-plugin-content-docs/current/module/auto-range-ban.md (1)
3-3: 文档格式已优化,内容保持不变仅移除了行尾多余空格,符合统一的格式化规范,无任何其他问题。
i18n/en/docusaurus-plugin-content-docs/current/module/ip-address-blocker-rules.md (1)
3-3: 行尾空格已成功移除,保持文档整洁。i18n/en/docusaurus-plugin-content-docs/current/module/expression-engine.md (1)
7-12: 移除行尾空格已确认无误仅去除了行尾多余的空格,文档内容未受影响,排版一致性更佳。
i18n/en/docusaurus-plugin-content-docs/current/module/multi-dial.md (1)
3-3: 格式修正已符合 PR 目标已成功删除行尾多余空格,文档渲染和版式更为统一,无任何功能性影响。
docs/module/progress-cheat-blocker.md (1)
3-3: 移除行尾空格提升 Markdown 规范性仅清理了行尾多余空格,正文保持不变,符合文档格式化最佳实践,无其他问题。
Also applies to: 16-16, 20-20
i18n/en/docusaurus-plugin-content-docs/current/module/active-monitoring.md (1)
3-6: 行尾空格已成功移除,符合 Markdown 规范
改动仅清理格式,无语义变化。docs/module/ip-address-blocker-rules.md (1)
3-3: 删除行尾空格 👍纯粹的格式修正,无语义改动,保持文档一致性。
docs/downloader/qBittorrent.md (1)
9-9: 删除行尾空格 👍符合统一排版规范,无其他问题。
docs/module/peer-id.md (1)
3-3: 删除行尾空格 👍仅清理多余空格,内容保持不变。
docs/statistic/charts.md (1)
23-23: 删除行尾空格 👍文档一致性改善,无需其他调整。
docs/downloader/qBittorrentEE.md (1)
9-9: 删除行尾空格 👍两处警告段落去除多余空格,版式更整洁。
Also applies to: 22-22
i18n/en/docusaurus-plugin-content-docs/current/platform/Windows.md (1)
5-5: 保持文档整洁仅删除了行尾多余空格,无实际内容变动,操作正确。
i18n/en/docusaurus-plugin-content-docs/current/module/ip-address-blocker.md (1)
25-25: 格式化修正已确认两处去除尾随空格,符合提交目标,无其他问题。
Also applies to: 36-36
docs/intro.md (1)
30-30: 微调 OK移除多余空格,文档语义不受影响。
Also applies to: 32-32
docs/module/client-name.md (1)
3-3: 一致性改进尾随空格已清理,保持排版统一。
Also applies to: 5-5
i18n/en/docusaurus-plugin-content-docs/current/downloader/qBittorrentEE.md (1)
22-22: LGTM仅格式化调整,无内容变更。
i18n/en/docusaurus-plugin-content-docs/current/module/client-name.md (1)
3-3: 删除行尾空格 👍符合本 PR 目标,内容未变。
i18n/en/docusaurus-plugin-content-docs/current/statistic/charts.md (1)
11-11: 删除行尾空格 👍无语义变动。
i18n/en/docusaurus-plugin-content-docs/current/downloader/qBittorrent.md (1)
43-43: 删除行尾空格 👍保持文档整洁。
i18n/en/docusaurus-plugin-content-docs/current/faq.md (1)
5-5: 删除行尾空格 👍无需其他改动。
docs/downloader/Transmission.md (3)
29-29: 删除行尾空格 👍
32-32: 删除行尾空格 👍
48-48: 删除行尾空格 👍docs/btn/connect.md (1)
11-11: 行尾空格删除已验证
纯粹的排版修正,对实际内容及链接无任何影响,可直接合并。docs/downloader/BiglyBT.md (1)
9-9: 保持一致的空白字符风格 👍
去除多余空格提升了 Markdown 的整洁度,与本 PR 目标一致。docs/faq.md (1)
18-21: 同上,删除空格无问题
其余修改仅为空白字符调整,可放心合并。i18n/en/docusaurus-plugin-content-docs/current/downloader/Transmission.md (2)
29-29: Whitespace cleanup acknowledged
无语义变化,保持文档统一。
47-47: 保持风格一致
再一次确认仅排版调整,内容正常。docs/module/expression-engine.md (4)
3-3: 空白字符移除确认
文档内容未变,改动安全。
7-7: 一致性维护
继续保持无多余空格,👍。
12-12: LGTM
纯格式变更,无需其他操作。
43-43: 排版一致性 OK
文档质量获得微小提升。i18n/en/docusaurus-plugin-content-docs/current/downloader/BitComet.md (1)
13-14: 格式一致性改进已落实
仅移除了行尾多余空格并补全了句末标点,内容保持不变,避免了 Markdown 渲染时可能出现的差异。无需进一步动作。Also applies to: 23-24, 28-30, 61-63
docs/module/ip-address-blocker.md (1)
23-24: 排版优化已确认
本段仅做空白字符清理,没有语义改动。LanguageTool 的量词提示为误报,可忽略。Also applies to: 30-31, 34-36, 56-58
docs/network/http-server.md (1)
36-38: 补充说明保持简洁
去除行尾空格后,列表项保持结构清晰,无需额外调整。docs/downloader/BitComet.md (2)
9-10: 句末空格清理 👍
删除空格不会影响阅读,符合本 PR 目标。
77-78: 图片引用行尾空格移除已确认
无其他问题。docs/network/proxy-server.md (1)
7-10: 说明同步更新
将 “Socks5 代理:目前不可用” 与前三项保持相同行末冒号格式,阅读更顺畅,修改符合预期。i18n/en/docusaurus-plugin-content-docs/current/downloader/BiglyBT.md (1)
39-40: 改动仅为去除行尾空格,确认无误行尾空格移除👍。无其他问题。
- 将 Docker Compose 和 CLI 示例中的时区从 UTC 修改为 Asia/Shanghai - 优化 Docker CLI 部署命令的格式和可读性
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
docs/setup/Docker.md (4)
33-36: 时区改为 Asia/Shanghai 没问题,但建议补充“可自定义时区”的说明当前示例硬编码为 Asia/Shanghai,适合国内用户。为避免读者误以为必须使用此时区,建议在代码块下补充一句“TZ 可按需改为你的本地时区(例如 Europe/Berlin、UTC 等)”以提升可读性与适用性。
35-39: 建议将 docker-compose 命令更新为新版语法Docker Compose V1 已弃用,推荐使用插件式命令 docker compose。可直接替换命令以减少误导。
应用如下最小变更:
-保存并退出编辑器,执行命令 `sudo docker-compose up -d` 以启动服务。Web 界面将在 9898 端口开放。 +保存并退出编辑器,执行命令 `sudo docker compose up -d` 以启动服务。Web 界面将在 9898 端口开放。
49-58: CLI 示例与提示用法不一致,且建议对路径加引号
- 示例使用
${PWD},而提示中使用 $ (pwd)/,两者不一致,易困惑。- 若路径包含空格,推荐对主机路径加引号,避免挂载失败。
建议统一并加引号,同时去掉多余的尾部斜杠,示例如下:
- -v ${PWD}/:/app/data/ \ + -v "${PWD}:/app/data" \并修正提示文本中的用法说明:
-在 `-v` 参数中,`$(pwd)/` 表示当前工作目录,应替换为你希望用作数据目录的路径。同时,将 `你的镜像标签` 替换为你刚刚获取的 Docker 镜像标签。 +在 `-v` 参数中,`${PWD}` 表示当前工作目录,建议对路径加引号以避免空格导致的问题。同时,将 `你的镜像标签` 替换为你刚刚获取的 Docker 镜像标签。另外,PUID/PGID 设为 0 表示以容器内 root 运行。建议在文档中注明“可将其设置为宿主机当前用户 UID/GID,以避免生成 root 拥有的文件”。
69-77: Podman Quadlet 中同时指定 Network=host 与 PublishPort 可能造成混淆在 host 网络模式下无需 PublishPort,且该项会被忽略。建议删除 PublishPort 以避免误导。
可做如下精简:
Volume=/path/to/pbh-data:/app/data -PublishPort=9898:9898 Network=host Environment=PUID=0 Environment=PGID=0 Environment=TZ=Asia/Shanghai同上,建议在示例下方补充一句“TZ 可按需改为你的本地时区”。
i18n/en/docusaurus-plugin-content-docs/current/setup/Docker.md (1)
47-61: Docker CLI 示例更完善,赞;补充两点可用性优化本段比之前更易用,建议微调:
- 对主机路径加引号,避免包含空格时挂载失败。
- 将 TZ 从固定 UTC 改为可替换占位,提示用户按需设置;或在段落说明中注明可改为本地时区。
- 可与 Compose 示例的容器名风格保持一致(可选)。
可直接在命令中做最小变更:
- -v ${PWD}/:/app/data/ \ + -v "${PWD}:/app/data" \ @@ - -e TZ=UTC \ + -e TZ=<your_timezone> \如需保持命名一致(可选):
- --name PeerBanHelper \ + --name peerbanhelper \同时建议在命令块下补充一句说明:Replace <your_timezone> with your local timezone, e.g., Asia/Shanghai or UTC.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
docs/setup/Docker.md(3 hunks)i18n/en/docusaurus-plugin-content-docs/current/setup/Docker.md(1 hunks)
Summary by CodeRabbit