docs: trim repetitive feature list in README header#6
Conversation
Swap the raster nine-feature overview (PNG) for a vector SVG across the README and docs (index, nine-feature-overview), and drop the orphaned PNG. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The nine feature areas were enumerated in prose three times around the overview figure (tagline, figure caption, intro). Collapse to a concise tagline, drop the redundant caption, and let the figure + section table carry the enumeration. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
审阅者指南(在小型 PR 上折叠显示)审阅者指南更新 README 和文档,将冗长、重复的功能罗列替换为精炼标语,将概览图片从 PNG 切换为 SVG,并在加入新的 SVG 资源的同时,进一步澄清九个部分的整体结构。 文件级变更
提示与命令与 Sourcery 交互
自定义你的体验访问你的控制面板以:
获取帮助Original review guide in EnglishReviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates the README and docs to replace a verbose, repetitive feature enumeration with a concise tagline, switch overview images from PNG to SVG, and clarify the nine-section organization while adding the new SVG asset. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
嘿,我已经审查了你的更改,看起来很棒!
帮我变得更有用!请在每条评论上点击 👍 或 👎,我会根据你的反馈改进审查质量。
Original comment in English
Hey - I've reviewed your changes and they look great!
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
This PR streamlines top-level documentation by removing repetitive prose lists of pyXenium’s “nine feature areas” in the README header and switching the “nine-feature overview” graphic from PNG to SVG where it’s embedded in the README and Sphinx docs.
Changes:
- Replace the README header’s long feature enumeration with a concise one-line tagline.
- Switch the embedded “nine-feature overview” image from PNG to SVG in the README.
- Update Sphinx
{figure}directives to reference the SVG asset in the docs index and the “nine-feature overview” page.
Reviewed changes
Copilot reviewed 3 out of 5 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Simplifies the header tagline and updates the overview image reference to SVG while removing redundant prose. |
| docs/user-guide/nine-feature-overview.md | Updates the MyST {figure} to use the SVG overview graphic. |
| docs/index.md | Updates the homepage {figure} to use the SVG overview graphic. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collapses the three prose enumerations of the nine feature areas (tagline, figure caption, intro) into a single concise tagline. The overview figure and the section table now carry the enumeration — no prose repetition.
🤖 Generated with Claude Code
Summary by Sourcery
简化并去重 README 中的特性描述,同时将概览图切换为 SVG 资源。
Documentation:
Original summary in English
Summary by Sourcery
Simplify and deduplicate the README’s feature description while switching overview graphics to SVG assets.
Documentation: