docs(readme): lead with positioning, not feature description#7526
docs(readme): lead with positioning, not feature description#7526JohnMcLear merged 1 commit intoether:developfrom
Conversation
- Rewrite title + About to lead with what Etherpad is for (authorship, sovereignty, malleability) before features - Rewrite Project Status to make the maintainer ask specific and to situate the project's 16-year track record - Add new "Who uses Etherpad" section with categorical adopter profiles so institutional evaluators have proof points on-page No code or behaviour changes. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Review Summary by QodoReposition README to lead with positioning and institutional proof points
WalkthroughsDescription• Repositions README to lead with Etherpad's core differentiators (authorship, sovereignty, AI control) rather than generic feature description • Rewrites Project Status section to highlight 16-year stability and make maintainer recruitment specific and actionable • Adds new "Who uses Etherpad" section with categorical adopter profiles (Wikimedia, public sector, education, civic-tech, newsrooms, self-hosters) to provide institutional proof points • No code, build, or behaviour changes — README documentation only Diagramflowchart LR
A["Old README<br/>Generic feature description"] -->|"Lead with<br/>differentiators"| B["New Title & About<br/>Authorship, Sovereignty, AI control"]
A -->|"Strengthen<br/>project narrative"| C["Updated Project Status<br/>16-year stability + maintainer ask"]
A -->|"Add institutional<br/>proof points"| D["New Who Uses Section<br/>Categorical adopter list"]
B --> E["Institutional evaluators<br/>find clear positioning"]
C --> E
D --> E
File Changes1. README.md
|
Code Review by Qodo
|
|
|
||
| Etherpad runs on your server, under your governance. No telemetry. No upsells. AI is a plugin you install, pointed at the model you choose, running on infrastructure you control — not a feature decided for you in a boardroom you weren't in. | ||
|
|
||
| The code is Apache 2.0. The data format is open. It [scales to thousands of simultaneous editors per pad](http://scale.etherpad.org/). Translated into 105 languages. Extended through hundreds of plugins. Used by Wikimedia, governments, public-sector institutions, and self-hosters worldwide since 2009. |
There was a problem hiding this comment.
1. http://scale.etherpad.org/ link added 📘 Rule violation ⛨ Security
The README introduces a hard-coded protocol-specific URL (http://scale.etherpad.org/), which violates the requirement to use protocol-independent URLs where applicable. This can reduce compatibility across HTTP/HTTPS deployments and may encourage insecure HTTP usage.
Agent Prompt
## Issue description
A protocol-specific URL (`http://...`) was added to the README, but the compliance checklist requires protocol-independent URLs where applicable.
## Issue Context
This is in the README copy where the scalability link is referenced.
## Fix Focus Areas
- README.md[15-15]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
|
|
||
| Every keystroke is attributed to its author. Every revision is preserved. The timeslider lets you scrub through a document's entire history, character by character. Author colours make collaboration visible at a glance — not buried in a menu. | ||
|
|
||
| Etherpad runs on your server, under your governance. No telemetry. No upsells. AI is a plugin you install, pointed at the model you choose, running on infrastructure you control — not a feature decided for you in a boardroom you weren't in. |
There was a problem hiding this comment.
2. Misleading telemetry statement 🐞 Bug ≡ Correctness
README now claims "No telemetry" even though Etherpad logs client IP addresses by default unless IP logging is explicitly disabled, which can mislead privacy-sensitive evaluators. This is especially risky given the surrounding positioning copy about sovereignty/governance.
Agent Prompt
## Issue description
README states "No telemetry" but Etherpad logs client IP addresses by default (unless `disableIPlogging`/`DISABLE_IP_LOGGING` is enabled). This makes the README privacy posture inaccurate.
## Issue Context
- Default configuration enables IP logging (`disableIPlogging: false`).
- Server access logs include `socket.request.ip` when IP logging is enabled.
## Fix Focus Areas
- README.md[11-16]
## Suggested change
Replace "No telemetry." with a statement that matches reality, e.g.:
- "No third-party telemetry." (if accurate), and/or
- "IP logging can be disabled." with a link to the relevant settings/docs.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
|
I like the new readme. It is much clearer and more concise. Do we have more recent data. I am not sure if all of them in the list still use etherpad. We created this scanner back then maybe there is more up to date information. |
Summary
Rewrites the top of the README to lead with what Etherpad is for rather than a feature description. No code, build, or behaviour changes — README only.
Three logical changes:
Title + About section. The current opening is generic enough that any of a dozen real-time editors could use the same line. Replaced with positioning copy that names the three pillars Etherpad is differentiated on:
Project Status. The current single line undersells both the project's track record and the maintainer ask. Rewritten to (a) state the 16-year stability story and (b) make the maintainer recruitment ask specific and actionable. Funding mention removed for now per maintainer guidance.
New "Who uses Etherpad" section. Currently the README has no proof points — institutional evaluators have to leave the README to find adopter info. Added a short categorical list (Wikimedia, EU public sector, schools, civic-tech, newsrooms, self-hosters) with a pointer to the existing
Sites-That-Run-Etherpadwiki for organisations who want to be listed by name.Why now
This is part of a broader positioning exercise to give Etherpad a clearer story for institutional adopters facing new mandates around digital sovereignty and AI provenance. The README is the highest-leverage surface for that story — most evaluators land here first.
What this PR does not change
Deliberately scoped small. Not touched:
Follow-up positioning work (etherpad.org website edits, manifesto/about page, comparison page) is being tracked separately.
Test plan
🤖 Generated with Claude Code