docs: declutter README header#7
Merged
Merged
Conversation
Contributor
评审者指南（在小型 PR 上折叠显示）评审者指南通过移除页首多余的区块来简化 README 头部，改用 SVG 代替 PNG 作为概览图资源，以提升文档渲染效果，并更新开头句子以强调九个规范章节，同时将新的 SVG 资源添加到文档静态文件中。 文件级变更
提示与命令与 Sourcery 交互
自定义你的体验访问你的 控制面板 来：
获取帮助Original review guide in EnglishReviewer's guide (collapsed on small PRs)Reviewer's GuideDeclutters the README header by removing extraneous top-of-page blocks, switches the overview figure assets from PNG to SVG for better docs rendering, and updates the intro sentence to emphasize the nine canonical sections with a new SVG asset added to the docs static files. 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}
Contributor
There was a problem hiding this comment.
Hey - 我在这里给出了一些总体反馈：
- 将概览图片切换为 SVG 非常好，不过建议再通过优化工具（例如 svgo）处理一下，以减小文件大小并去除不必要的元数据，这可以提升 README 和文档的加载性能。
- 从 README 头部移除导航链接行之后，顶部看起来更简洁，但你可能需要确保在 README 的其他位置仍然提供同样醒目的导航链接，方便用户快速访问 PyPI、文档、更新日志和发布说明。
供 AI 代理使用的提示
Please address the comments from this code review:
## Overall Comments
- Switching the overview image to SVG is great, but consider running it through an optimizer (e.g., svgo) to reduce file size and strip unnecessary metadata, which will improve load performance for the README and docs.
- Removing the navigation link row from the README header makes the top cleaner, but you might want to ensure equivalent prominent navigation to PyPI, docs, changelog, and releases exists elsewhere in the README so users can still discover those quickly.帮我变得更有用！请在每条评论上点击 👍 或 👎，我会根据你的反馈改进后续评审。
Original comment in English
Hey - I've left some high level feedback:
- Switching the overview image to SVG is great, but consider running it through an optimizer (e.g., svgo) to reduce file size and strip unnecessary metadata, which will improve load performance for the README and docs.
- Removing the navigation link row from the README header makes the top cleaner, but you might want to ensure equivalent prominent navigation to PyPI, docs, changelog, and releases exists elsewhere in the README so users can still discover those quickly.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Switching the overview image to SVG is great, but consider running it through an optimizer (e.g., svgo) to reduce file size and strip unnecessary metadata, which will improve load performance for the README and docs.
- Removing the navigation link row from the README header makes the top cleaner, but you might want to ensure equivalent prominent navigation to PyPI, docs, changelog, and releases exists elsewhere in the README so users can still discover those quickly.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Remove the logo banner, the one-line tagline, and the navigation link row from the README header. Title, badges, overview figure, and the section table remain. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
hutaobo
force-pushed
the
claude/zen-ishizaka-19fb62
branch
from
58d91f0 to
3f9aaa6
Compare
There was a problem hiding this comment.
Pull request overview
This PR streamlines the project’s documentation landing surfaces by simplifying the README header and switching the “nine-feature overview” image references from PNG to a shared SVG asset.
Changes:
- Removed the README’s logo banner, tagline paragraph, and navigation link row to reduce header clutter.
- Updated the README and Sphinx docs pages to reference
pyxenium-nine-feature-overview.svginstead of the PNG. - Tweaked surrounding README intro text around the “nine major sections” table.
Reviewed changes
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Removes extra header blocks, updates the overview figure to SVG, and adjusts the short intro sentence above the section table. |
| docs/user-guide/nine-feature-overview.md | Updates the MyST {figure} directive to load the SVG overview figure. |
| docs/index.md | Updates the homepage {figure} directive to load the SVG overview figure. |
Comments suppressed due to low confidence (1)
README.md:16
- This change removes the only short description of what pyXenium is (Python toolkit for 10x Genomics Xenium). That conflicts with the PR goal of keeping the core project introduction intact and makes the README header less informative for first-time readers.
pyXenium is organized around nine major sections, each with a canonical entry point:
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| </p> | ||
|
|
||
| <p align="center"> | ||
| <img src="https://raw.githubusercontent.com/hutaobo/pyXenium/main/docs/_static/figures/pyxenium-nine-feature-overview.svg" alt="pyXenium nine-feature overview figure" width="960"> |
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.
Removes three header blocks for a cleaner top of the README: the logo banner, the one-line tagline, and the navigation link row (PyPI · conda-forge · …). The centered title, badge row, overview figure, and section table remain.
🤖 Generated with Claude Code
由 Sourcery 提供的摘要
在保留项目核心介绍的前提下，精简 README 和文档总览图。
文档：
Original summary in English
Summary by Sourcery
Streamline the README and documentation overview figure while keeping the core project introduction intact.
Documentation: