Skip to content

docs(readme): move Sponsors section to the top #2466

Merged
naorpeled merged 1 commit into
mainfrom
chore/readme-sponsors-top
Jun 21, 2026
Merged

docs(readme): move Sponsors section to the top #2466
naorpeled merged 1 commit into
mainfrom
chore/readme-sponsors-top

Conversation

@naorpeled

@naorpeled naorpeled commented Jun 21, 2026

Copy link
Copy Markdown
Member

What

Moves the Sponsors section from near the bottom of the README up to just below the intro paragraph (above the Table of Contents), so the Gold sponsor is prominent near the top.

  • Sponsors is now the first ## section, with a centered "🥇 Gold Sponsor" presentation (Qodo logo + links).
  • Dropped the now-redundant Sponsors entry from the Table of Contents (the section sits above the TOC).

Relocate the Sponsors section from near the bottom to just below the intro
(above the Table of Contents) so the Gold sponsor is prominent near the top,
mirroring vuejs/core's README layout. Use a centered presentation and drop the
now-redundant Sponsors entry from the Table of Contents.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 21, 2026
@qodo-free-for-open-source-projects

Copy link
Copy Markdown
Contributor

PR Summary by Qodo

docs(readme): move Sponsors section near top (vuejs-style)
📝 Documentation 🕐 Less than 5 minutes

Grey Divider

Description

• Move Sponsors section below the intro to increase sponsor visibility.
• Center the Gold sponsor logo and call-to-action near the top.
• Remove the Sponsors entry from the Table of Contents since it now precedes it.
High-Level Assessment

The chosen approach is appropriate for a README-only change: moving the section and adjusting the TOC keeps the document consistent and improves sponsor prominence without introducing additional maintenance overhead.

Files changed (1) +19 / -13

Documentation (1) +19 / -13
README.mdPromote Sponsors section to top and adjust TOC +19/-13

Promote Sponsors section to top and adjust TOC

• Moves the Sponsors section from near the bottom of the README to directly below the introduction, above the Table of Contents. Updates the Sponsors presentation to a centered Gold sponsor block and removes the now-redundant TOC entry for Sponsors.

README.md

@qodo-free-for-open-source-projects

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (2) 📘 Rule violations (0) 📜 Skill insights (0)

Grey Divider


Remediation recommended

1. Blank-target without rel 🐞 Bug ⛨ Security
Description
README.md adds links with target="_blank" but no rel="noopener noreferrer", which can enable
reverse-tabnabbing in renderers that preserve these attributes.
Code

README.md[R39-46]

+  <a target="_blank" href="https://www.qodo.ai/">
+    <img alt="Qodo — Gold sponsor" src="https://www.qodo.ai/wp-content/uploads/2025/03/qodo-logo.svg" width="300">
+  </a>
+</p>
+
+<p align="center">
+  <a target="_blank" href="https://www.qodo.ai/get-started/">Try the free version of Qodo</a>
+</p>
Evidence
Both sponsor links explicitly set target="_blank" and omit any rel attribute in the new README
Sponsors section.

README.md[39-46]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
Links opened with `target="_blank"` should include `rel="noopener noreferrer"` to prevent the opened page from accessing `window.opener`.

### Issue Context
The Sponsors section introduces two external links using `target="_blank"`.

### Fix Focus Areas
- README.md[39-46]

### Suggested change
Add `rel="noopener noreferrer"` to both anchors, e.g.:
```html
<a target="_blank" rel="noopener noreferrer" href="https://www.qodo.ai/">
...
<a target="_blank" rel="noopener noreferrer" href="https://www.qodo.ai/get-started/">...
```

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools



Informational

2. Invalid HTML nesting 🐞 Bug ⚙ Maintainability
Description
README.md nests a block-level <h3> inside a <p>, which is invalid HTML and may be auto-corrected
differently by Markdown/HTML renderers (affecting the intended centered layout).
Code

README.md[R34-36]

+<p align="center">
+  <h3 align="center">🥇 Gold Sponsor</h3>
+</p>
Evidence
The updated README introduces <p align="center"> containing an <h3> element, creating invalid
HTML structure in the rendered Sponsors section.

README.md[34-36]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The Sponsors section wraps an `<h3>` inside a `<p>`, which is invalid HTML and can lead to inconsistent rendering.

### Issue Context
The PR introduces centered markup for the Gold Sponsor heading.

### Fix Focus Areas
- README.md[34-36]

### Suggested change
Replace the wrapper with a single centered heading, e.g.:
```html
<h3 align="center">🥇 Gold Sponsor</h3>
```
(or use a `<div align="center">...</div>` wrapper instead of `<p>`).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

  • Author self-review: I have reviewed the code review findings, and addressed the relevant ones.

Qodo Logo

@naorpeled naorpeled changed the title docs(readme): move Sponsors section to the top (vuejs-style) docs(readme): move Sponsors section to the top Jun 21, 2026
@naorpeled naorpeled merged commit 3bfd5b0 into main Jun 21, 2026
6 checks passed
@naorpeled naorpeled deleted the chore/readme-sponsors-top branch June 21, 2026 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant