Skip to content

docs: Readme tidy#7725

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

docs: Readme tidy#7725
JohnMcLear merged 3 commits into
developfrom
readme-tidy

Conversation

@JohnMcLear
Copy link
Copy Markdown
Member

Hopefully the final docs tidy

@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.

@JohnMcLear JohnMcLear merged commit 8b14eb6 into develop May 11, 2026
35 of 41 checks passed
@JohnMcLear JohnMcLear deleted the readme-tidy branch May 11, 2026 14:04
@qodo-free-for-open-source-projects
Copy link
Copy Markdown

Review Summary by Qodo

Clean up README links and remove outdated badges

📝 Documentation

Grey Divider

Walkthroughs

Description
• Updated "Try it out" link to direct instance
• Simplified badge labels removing vendor references
• Removed outdated Sauce Labs and Windows badges
• Updated plugins link to official Etherpad plugins page
• Replaced wiki reference with public instances scanner
Diagram
flowchart LR
  A["README.md"] -->|"Update Try it out link"| B["scanner.etherpad.org"]
  A -->|"Simplify badge labels"| C["Remove vendor references"]
  A -->|"Remove outdated badges"| D["Sauce Labs & Windows"]
  A -->|"Update plugins link"| E["etherpad.org/plugins"]
  A -->|"Replace wiki reference"| F["scanner.etherpad.org"]
Loading

Grey Divider

File Changes

1. README.md 📝 Documentation +5/-7

Modernize links and clean up badge references

• Updated "Try it out" link from wiki to scanner.etherpad.org
• Simplified frontend test badge labels by removing "powered by Sauce Labs" text
• Removed Sauce Test Status and Windows Build badges
• Updated Etherpad plugins badge link from static.etherpad.org/index.html to
 etherpad.org/plugins
• Replaced wiki-based organization instances section with direct link to scanner.etherpad.org

README.md


Grey Divider

Qodo Logo

@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. Hard-coded https://scanner.etherpad.org URL 📘 Rule violation ⚙ Maintainability
Description
The README changes introduce hard-coded https:// URLs instead of protocol-independent // URLs.
This can reduce compatibility across HTTP/HTTPS deployments where protocol independence is expected.
Code

README.md[21]

+[Try out a public Etherpad instance](https://scanner.etherpad.org)
Evidence
PR Compliance ID 8 requires using protocol-independent URLs where applicable, but the updated README
includes links with explicit https:// schemes: it adds https://scanner.etherpad.org (including a
variant with a trailing slash https://scanner.etherpad.org/) and updates the plugins link to
https://etherpad.org/plugins, each of which hard-codes the protocol rather than using //....

README.md[21-21]
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 contains link targets that are hard-coded to use `https://...` instead of protocol-independent `//...` URLs; per compliance requirements, these should be made protocol-independent where applicable to preserve compatibility across HTTP/HTTPS deployments.

## Issue Context
This PR updates README links, including adding links to `scanner.etherpad.org` (with and without a trailing slash) and changing the Etherpad plugins link to `https://etherpad.org/plugins`, all of which currently hard-code the protocol.

## Fix Focus Areas
- README.md[21-21]
- 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. Misleading public instance label 🐞 Bug ≡ Correctness
Description
In README.md, the “Try it out” section labels the link as a “public Etherpad instance” but it
actually points to a third-party instance directory, and the third-party disclaimer is only stated
later in the document. This can incorrectly imply the Etherpad Foundation provides an official
hosted demo/service.
Code

README.md[21]

+[Try out a public Etherpad instance](https://scanner.etherpad.org)
Evidence
The README first invites users to “Try out a public Etherpad instance” linking to
scanner.etherpad.org without qualification, but later describes the same destination as “Third party
instances not provided by the Etherpad foundation,” demonstrating the initial label lacks necessary
context.

README.md[19-22]
README.md[50-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
The README “Try it out” link points to a third-party instance directory, but the label reads like an official/public Etherpad instance. The only third-party disclaimer is placed later in the README, so readers can easily miss it.

## Issue Context
`https://scanner.etherpad.org` is presented as a place to try Etherpad, but it is not an Etherpad Foundation-run service (the README later acknowledges this). The disclaimer should be adjacent to the first occurrence to avoid misleading readers.

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

ⓘ 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