Fix minor README glitches, update Cirq logo to respond to dark/light mode, and add QAI logo #7186
Conversation
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
I guess I accidentally left an empty `#` at the top of the file. This leads to a minor glitch in the markdown rendering on GitHub.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7186 +/- ##
==========================================
- Coverage 98.66% 98.66% -0.01%
==========================================
Files 1106 1106
Lines 96086 96086
==========================================
- Hits 94808 94806 -2
- Misses 1278 1280 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
pavoljuhas
requested changes
Mar 25, 2025
There was a problem hiding this comment.
The logo image needs to have an absolute URL for PyPI.
If it takes too much work to verify if light / dark logos work on PyPI it is probably not worth the trouble and an extra likelihood of breaking things by us or by GitHub in the future.
https://www.geeksforgeeks.org/kiss-principle-in-software-development/
LGTM for the text tweaks.
PS: consider removing the #readme anchors, it is unclear if they improve usability for visitors.
I noticed that several of the other projects have (or had) sections titled How to Cite, and then in some documentation files, the links to citation info uses `#how-to-cite` anchors. Just to be safe in case not all links have been updated everywhere, let's add an additional hyperlink anchor `#how-to-cite` here too.
Don't need to use `<name@address>` when `name@address` will do.
This uses a GitHub feature for detecting if the user has turned on dark mode, and switches the Cirq logo appropriately.
Per review comments.
mhucka
force-pushed
the
mh-fix-readme-glitches
branch
from
42f0b4f to
034e276
Compare
|
I forced-pushed an update that removed the use of |
Turns out to be unnecessary after all.
Also changed the <title> tag value to something more sensible.
The new text is per latest Google guidance for open-source projects.
mhucka
changed the title
This one has been adapted to use light/dark mode handling.
pavoljuhas
approved these changes
Apr 24, 2025
This was referenced May 30, 2025
BichengYing
pushed a commit
to BichengYing/Cirq
that referenced
this pull request
Jun 20, 2025
…mode, and add QAI logo (quantumlib#7186) * Remove blank H1 heading I guess I accidentally left an empty `#` at the top of the file. This leads to a minor glitch in the markdown rendering on GitHub. * Add additional #how-to-cite anchor I noticed that several of the other projects have (or had) sections titled How to Cite, and then in some documentation files, the links to citation info uses `#how-to-cite` anchors. Just to be safe in case not all links have been updated everywhere, let's add an additional hyperlink anchor `#how-to-cite` here too. * Use a bare link for the contact email address Don't need to use `<name@address>` when `name@address` will do. * Add versions of the Cirq logo for black and white backgrounds * Switch logos depending on dark or light mode This uses a GitHub feature for detecting if the user has turned on dark mode, and switches the Cirq logo appropriately. * Remove duplicate logo file & rename remaining one Per review comments. * Put back absolute image URLs * Use <picture> for logo * Remove Cirq_logo_color_white_text.svg Turns out to be unnecessary after all. * Make logo responsive to light/dark mode Also changed the <title> tag value to something more sensible. * Update disclaimer in README The new text is per latest Google guidance for open-source projects. * Add QAI logo to bottom of README file * Add a copy of the QAI logo in SVG format This one has been adapted to use light/dark mode handling.
This was referenced Aug 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Changes:
Remove empty H1 heading that I must have accidentally left in
Update Cirq logo SVG to switch to using white letters when the user has dark mode enabled
Add the QAI logo to the bottom of the page.
Add an aditional anchor named
#how-to-cite, for better backward compatibility with some documentation that might have used (or still uses) a link with that anchorFix a random niggle or two