docs: 帮助图 slogan + README 命令一览 + KB 别名，并补 2.0.3 反代变更#78
Merged
Conversation
- 帮助图副标题改为 "Everything is RSSable"，并重新生成 light/dark 帮助图。 - README 顶部加 Last Commit 徽章，新增「命令一览」段贴帮助图。 - docs/usage/commands.md 补全 RSSHub Routes 知识库命令的中文别名。 - CHANGELOG 2.0.3 补记媒体反代（image/media relay，先反代再回源、缓存键保持原始 URL）与无声视频转 GIF 体积上限压缩，刷新发版内容。
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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. Comment |
github-actions
Bot
added
area: docs
审阅者指南（在小型 PR 上折叠）审阅者指南此 PR 刷新了用户可见的文档和帮助资源（帮助图片、README、命令文档、更新日志），以确保命令、KB 别名以及与媒体相关的发布说明是准确的，并与当前行为保持一致，同时不修改任何运行时逻辑。 2.0.3 版本 CHANGELOG 中记录的媒体转发行为流程图flowchart TD
A[Original_media_url] --> B[Check_content_type]
B -->|is_image| C[Proxy_via_media.image_relay_base_url]
B -->|not_image| D[Proxy_via_media.media_relay_base_url]
C --> E[Download_via_relay_then_origin]
D --> E
E --> F[Cache_with_original_URL_as_key]
F --> G[Serve_media_or_failure_link_with_original_URL]
文件级变更
技巧与命令与 Sourcery 交互
自定义你的体验打开你的控制面板 可以：
获取帮助Original review guide in EnglishReviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR refreshes user-facing documentation and help assets (help image, README, commands doc, changelog) so that commands, KB aliases, and media-related release notes are accurate and aligned with current behavior, without changing any runtime logic. Flow diagram for media relay behavior documented in 2.0.3 CHANGELOGflowchart TD
A[Original_media_url] --> B[Check_content_type]
B -->|is_image| C[Proxy_via_media.image_relay_base_url]
B -->|not_image| D[Proxy_via_media.media_relay_base_url]
C --> E[Download_via_relay_then_origin]
D --> E
E --> F[Cache_with_original_URL_as_key]
F --> G[Serve_media_or_failure_link_with_original_URL]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - 我提供了一些总体反馈：
- README 中的 Last Commit 徽章和命令概览图片都将分支名硬编码为
master；建议使用对默认分支不敏感的徽章配置，以及相对图片路径（或与分支无关的 URL），以便在默认分支发生变化或在 fork 仓库中时，这些内容仍能正常工作。
给 AI Agent 的提示
Please address the comments from this code review:
## Overall Comments
- The README’s Last Commit badge and the command overview image both hardcode the `master` branch; consider using a default-branch-insensitive badge configuration and a relative image path (or a branch-agnostic URL) so they keep working if the default branch changes or in forks.帮我变得更有用！请在每条评论上点 👍 或 👎，我会根据反馈改进之后的评审。
Original comment in English
Hey - I've left some high level feedback:
- The README’s Last Commit badge and the command overview image both hardcode the
masterbranch; consider using a default-branch-insensitive badge configuration and a relative image path (or a branch-agnostic URL) so they keep working if the default branch changes or in forks.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The README’s Last Commit badge and the command overview image both hardcode the `master` branch; consider using a default-branch-insensitive badge configuration and a relative image path (or a branch-agnostic URL) so they keep working if the default branch changes or in forks.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Pull request overview
Documentation-only PR that updates the help image subtitle, README, command aliases doc, and changelog entries for 2.0.3.
Changes:
- Update help template subtitle to "Everything is RSSable" and add README badge + command overview image.
- Document Chinese aliases for
/rsshub_kb_*commands. - Add 2.0.3 changelog entries for media relay and GIF size-limit compression.
Reviewed changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| scripts/template/rsshelp_template.html | Change help image subtitle to RSSHub slogan. |
| README.md | Add Last Commit badge and inline command overview image. |
| docs/usage/commands.md | Fill in Chinese aliases for KB commands. |
| CHANGELOG.md | Add 2.0.3 entries for media relay and GIF size compression. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
整理帮助图与文档，并补全 2.0.3 发版说明，让 release 内容反映媒体反代等变更。
Modifications / 改动点
帮助图：
scripts/template/rsshelp_template.html副标题改为Everything is RSSable（RSSHub 官方 slogan），并用scripts/gen_rsshelp.sh重新生成assets/help/rsshelp_light.png与rsshelp_dark.png。README.md：顶部新增 Last Commit 徽章；新增「命令一览」段，直接贴出帮助图。
docs/usage/commands.md：补全 RSSHub Routes 知识库命令（
/rsshub_kb_init/_sync/_status/_task）的中文别名，与代码入口一致。CHANGELOG.md（2.0.3）：补记本次发版包含的两项媒体能力——
media.image_relay_base_url/media.media_relay_base_url（图片优先图片反代、非图片走通用反代、先反代再回源、缓存键与失败链接保持原始 URL）。这样 release notes 能正确反映这些变更。
This is NOT a breaking change. / 这不是一个破坏性变更。
Screenshots or Test Results / 运行截图或测试结果
纯文档/帮助图改动，无代码逻辑变更。帮助图由仓库脚本生成：
帮助图顶部副标题已渲染为
Everything is RSSable。Checklist / 检查清单
Summary by Sourcery
更新文档、帮助资源和发行说明，以反映当前的命令以及新增加的媒体处理能力。
新功能：
增强：
文档：
Original summary in English
Summary by Sourcery
Update documentation, help assets, and release notes to reflect current commands and newly added media handling capabilities.
New Features:
Enhancements:
Documentation: