[CONTENT-3798] README update for marketing - #547
Conversation
| <p align="center"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://assets-eu-01.kc-usercontent.com/ef593040-b591-0198-9506-ed88b30bc023/a23fc7ba-23f0-489a-829d-ed88c0748521/Sonar_Logo_Dark%20Backgrounds.svg"> | ||
| <img src="https://assets-eu-01.kc-usercontent.com/ef593040-b591-0198-9506-ed88b30bc023/82c13eba-d95c-4bb8-8007-7ce77c14e043/Sonar_Logo_Light%20Backgrounds.svg" alt="Sonar logo" width="400"> | ||
| </picture> | ||
| </p> |
There was a problem hiding this comment.
💡 Quality: Second logo block: raster PNG light asset and lost centering
The two new logo blocks are inconsistent with each other: the first (<p align="center">, lines 1-6) is centered and uses SVG for both themes, while the second (lines 10-15) omits align="center" so the SonarQube Server logo renders left-aligned under the centered Sonar logo, and its light-mode <img src> points at a PNG (verified content-type: image/png) while its dark-mode <source srcset> is an SVG. Rendered at width="400", the raster light-mode asset will look softer than the dark-mode SVG and than the Sonar logo, and light-mode readers (the GitHub default) get the lower-quality variant. Use the SVG variant of the SonarQube Server light-background logo and add align="center" for visual consistency.
Center the second logo block and use the SVG light-background asset instead of the PNG (substitute the SVG URL from the same asset library).:
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://assets-eu-01.kc-usercontent.com/ef593040-b591-0198-9506-ed88b30bc023/19f97554-c5ec-4cf1-87f7-878c02a19702/SQ_Logo_Server_Dark%20Backgrounds.svg">
<img src="<SVG_URL_FOR_SQ_LOGO_SERVER_LIGHT_BACKGROUNDS>" alt="SonarQube Server logo" width="400">
</picture>
</p>
- Apply fix
Check the box to apply the fix or reply for a change | Was this helpful? React with 👍 / 👎
| <p> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://assets-eu-01.kc-usercontent.com/ef593040-b591-0198-9506-ed88b30bc023/19f97554-c5ec-4cf1-87f7-878c02a19702/SQ_Logo_Server_Dark%20Backgrounds.svg"> | ||
| <img src="https://assets-eu-01.kc-usercontent.com/ef593040-b591-0198-9506-ed88b30bc023/4a785d22-7141-409d-95a2-695c42595f90/SQ_Logo_Server_Light%20Backgrounds.png" alt="SonarQube Server logo" width="400"> | ||
| </picture> | ||
| </p> |
There was a problem hiding this comment.
💡 Quality: Only SonarQube Server logo shown though Cloud is also supported
The new branding block places the SonarQube Server product logo directly under the title, but the adjacent prose (README.md:24, README.md:33), the setup instructions, and server.json:5 all state the MCP server works with both SonarQube Server and SonarQube Cloud. A reader scanning the header will conclude Cloud is unsupported, contradicting the text three lines below. Either drop the product-specific logo or show Server and Cloud logos together so the branding matches the documented product scope.
Show both SonarQube Server and SonarQube Cloud logos (or neither) so the header matches the stated support for both products.:
<!-- Either remove the product-specific logo block (lines 10-15), or show both products: -->
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="<SQ_SERVER_DARK_SVG>">
<img src="<SQ_SERVER_LIGHT_SVG>" alt="SonarQube Server logo" width="300">
</picture>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="<SQ_CLOUD_DARK_SVG>">
<img src="<SQ_CLOUD_LIGHT_SVG>" alt="SonarQube Cloud logo" width="300">
</picture>
</p>
- Apply fix
Check the box to apply the fix or reply for a change | Was this helpful? React with 👍 / 👎
Code Review 👍 Approved with suggestions 0 resolved / 2 findingsREADME update adds responsive logos and badges with refreshed marketing copy while preserving setup, configuration, and security guidance. Two minor inconsistencies merit attention: the SonarQube Server logo block uses a lower-quality PNG light asset and lacks centering, whereas the Sonar block above uses SVGs and is centered; and the product-specific Server logo may mislead readers since the server supports both Server and Cloud per the documentation below. 💡 Quality: Second logo block: raster PNG light asset and lost centering📄 README.md:1-6 📄 README.md:10-15 The two new logo blocks are inconsistent with each other: the first ( Center the second logo block and use the SVG light-background asset instead of the PNG (substitute the SVG URL from the same asset library).💡 Quality: Only SonarQube Server logo shown though Cloud is also supported📄 README.md:10-15 📄 README.md:24 📄 README.md:33 The new branding block places the SonarQube Server product logo directly under the title, but the adjacent prose ( Show both SonarQube Server and SonarQube Cloud logos (or neither) so the header matches the stated support for both products.🤖 Prompt for agentsImplementation Status ✅ 1 of 1 objectives covered✅ CONTENT-3798 - 1 of 1 objectives coveredThis PR covers the objective to update the README with the Sonar logo and messaging. ✅ 1 covered here
OptionsAuto-apply is off → Gitar will not commit updates to this branch. Comment with these commands to change the behavior for this request:
Was this helpful? React with 👍 / 👎 | Gitar |
|



Summary
This PR makes a focused README marketing update:
The repository's existing setup, configuration, tool reference, security guidance, development instructions, and licensing are otherwise preserved.
Review guidance
These changes were prepared automatically using the shared README guidelines.
Please review the diff carefully for repository-specific and product-marketing accuracy, verify the logos in GitHub light and dark modes, and confirm that all required checks pass.
Merge ownership
If the changes are accurate and all required checks pass, please have a CODEOWNER merge this PR when you are ready. The rollout author will not merge it because the repository owners are best placed to assess repository-specific checks and any build impact.
If a check fails or a correction is needed, please leave the PR unmerged and add a review comment.
Validation
masteratcecc3702a2064748536012317ae68361fcc026bcQuick setuponward remains unchanged, including the current optionalcommentparameter for issue status changesThis is a documentation-only change and does not modify runtime code.
Tracking
Jira epic: CONTENT-3798