Skip to content

Readme tidy#7724

Merged
JohnMcLear merged 2 commits into
developfrom
readme-tidy
May 11, 2026
Merged

Readme tidy#7724
JohnMcLear merged 2 commits into
developfrom
readme-tidy

Conversation

@JohnMcLear
Copy link
Copy Markdown
Member

Missed this one :)

@qodo-code-review
Copy link
Copy Markdown

ⓘ You've reached your Qodo monthly free-tier limit. Reviews pause until next month — upgrade your plan to continue now, or link your paid account if you already have one.

@qodo-free-for-open-source-projects
Copy link
Copy Markdown

Review Summary by Qodo

Clean up README badges and fix documentation links

📝 Documentation

Grey Divider

Walkthroughs

Description
• Removed outdated Sauce Labs badge references
• Simplified badge labels for frontend tests
• Fixed Etherpad plugins link to official plugins page
• Updated public instances section with scanner link
Diagram
flowchart LR
  A["README.md"] -->|Remove Sauce Labs badges| B["Simplified badges"]
  A -->|Update plugin link| C["etherpad.org/plugins"]
  A -->|Replace instances section| D["scanner.etherpad.org"]
Loading

Grey Divider

File Changes

1. README.md 📝 Documentation +4/-6

Clean up badges and fix documentation links

• Removed 4 outdated badge lines including Sauce Labs references and Windows Build badge
• Simplified badge text from "powered by Sauce Labs" to plain labels
• Fixed Etherpad plugins badge link from static.etherpad.org to etherpad.org/plugins
• Replaced public instances wiki reference with direct link to scanner.etherpad.org

README.md


Grey Divider

Qodo Logo

@JohnMcLear JohnMcLear merged commit 5692c11 into develop May 11, 2026
33 of 39 checks passed
@qodo-free-for-open-source-projects
Copy link
Copy Markdown

qodo-free-for-open-source-projects Bot commented May 11, 2026

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (1)

Grey Divider


Remediation recommended

1. Protocol-specific plugins URL 📘 Rule violation ⛨ Security
Description
The updated README uses protocol-specific external links (https://...) instead of the
protocol-independent form (//...) where protocol-agnostic linking is required by project
guidelines. This can contribute to mixed-content/compatibility issues per the compliance checklist.
Code

README.md[46]

+[![Etherpad plugins](https://img.shields.io/endpoint?url=https%3A%2F%2Fstatic.etherpad.org%2Fshields.json&color=%2344b492 "Etherpad plugins")](https://etherpad.org/plugins)
Evidence
PR Compliance ID 9 requires protocol-independent URLs where applicable; however, the README changes
include links written with an explicit https:// scheme (e.g., https://etherpad.org/plugins and
https://scanner.etherpad.org/) rather than the protocol-independent equivalents
(//etherpad.org/plugins and //scanner.etherpad.org/), demonstrating a direct mismatch with the
guideline.

README.md[46-46]
README.md[61-61]
Best Practice: Repository guidelines

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 README introduces/keeps protocol-specific external URLs (`https://...`) where protocol-independent URLs (`//...`) are expected by the compliance checklist.

## Issue Context
PR Compliance ID 9 requires protocol-independent URLs where applicable to avoid mixed-content and compatibility issues.

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

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


2. Conflicting instance links 🐞 Bug ⚙ Maintainability
Description
README.md now points to two different sources for trying public Etherpad instances: the “Try it out”
section links to the GitHub wiki list, while the updated “Who uses Etherpad” section links to
scanner.etherpad.org. This creates inconsistent guidance for readers about where to go to find
public instances.
Code

README.md[61]

+[Public Etherpad Instances for you to try out.  Third party instances not provided by the Etherpad foundation](https://scanner.etherpad.org/).
Evidence
The README contains both links simultaneously after the PR, so readers get two different directions
for the same goal (finding a public instance).

README.md[19-22]
README.md[58-62]

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

## Issue description
README.md contains two different links for finding/trying public Etherpad instances (GitHub wiki vs scanner.etherpad.org), which is inconsistent guidance.

## Issue Context
After this PR, the “Try it out” section still points to the GitHub wiki list, but the “Who uses Etherpad” section now points to scanner.etherpad.org.

## Fix Focus Areas
- README.md[19-22]
- README.md[58-62]

## Suggested fix
Pick a single canonical destination (either the wiki list or the scanner) and use it in both places, or explicitly present both with clear wording (e.g., “Try a public instance (scanner)” and “Browse a curated list (wiki)”).

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


Grey Divider

Qodo Logo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant