StuMason/coolify-mcp
TypeScript
Pull Request Opened
PR #199 opened: docs: EAL accessibility sweep across the site
Tech-writer review flagged sentence complexity, idiom density, and em-dash overuse as a barrier for readers of English as an additional language. This PR is the fourth and final in the post-review cleanup series (after factual fixes / security.md / troubleshooting.md).
Changes
| File | Change |
|---|---|
mcp-primer.md | Split the 86-word opening paragraph into a short sentence + bulleted primitive list. Added a "New to MCP?" callout pointing at the official quickstart. Made the "client primitives unused" claim explicit. |
index.md | Replaced 6 idioms ("drop into", "one env var, you're running", "drop-in", "one-click slash commands", "walks through", etc.). Removed the unverifiable "responds within a day or two" claim. |
guide/quickstart.md | Replaced em-dash mid-clause with a colon. |
concepts/coolify-api-gotchas.md | Removed "unhappy surprises" and three mid-sentence em-dashes. Tightened the controller-vs-spec note. |
contributing/adding-tools.md | Softened the "The order matters. Follow it." opener. Replaced four em-dashes with colons or full stops. |
contributing/pr-flow.md | Replaced "ping the maintainer" with "post a comment". Removed unverifiable response-time claim. |
contributing/testing.md | Split a 35-word sentence. Replaced "before declaring done". |
roadmap/v3-vision.md | Rewrote the 47-word opening one-liner as three shorter sentences. Replaced "doesn't waste the user's hour" and several em-dashes. |
What this doesn't change
- No content removed (no information loss)
- No new dead links
- Tone stays personable; insider-jargon stripped only where it would block comprehension
- Em-dashes kept where they aid readability — the goal is to reduce density, not eliminate them
Site builds clean. After this lands, all four post-review priorities from the tech-writer audit are addressed.
+55
additions
-43
deletions
8
files changed