docs(readme): restructure for narrative, SEO, and GitHub UX conventions#842
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Automated approval for maintainer PR
All automated quality gates passed. See SECURITY_CONTROLS.md for compensating controls.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request comprehensively updates and restructures the README.md file to provide detailed documentation on the extension's features, installation, configuration, security, and development guidelines. The review feedback highlights opportunities to improve the documentation's accuracy and readability, specifically by clarifying the CKEditor extension key, using the correct extension key in the site configuration dependencies example, and adding syntax highlighting language specifiers to code blocks.
Rewrite README to lead with a positioning statement, add a table of contents, and a "Why this extension exists" narrative that surfaces the TYPO3 v10 RTE-image removal context (the search intent that brings most integrators here). Regroup features into four narrative subsections (editor experience, frontend rendering, integrity & maintenance, quality & security) instead of a flat bullet list. Move requirements to a table, number the installation steps, and add prose intros to each usage recipe so the snippets explain themselves. Promote security from a feature sub-bullet to its own section with all six defense layers and links to ADR-003 and SECURITY.md. Add a distribution-channels list to "Verifying releases" and an i18n note (31 languages, Crowdin) to "Contributing". Replace the marketing "Generated with 🧡" comment with a neutral one. No behavioural or factual changes — content is preserved verbatim where it was already correct (TypoScript snippets, ADR-004 storage convention, SLSA verification commands, DDEV URLs). Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>
CybotTM
force-pushed
the
docs/readme-narrative-seo
branch
from
1d97663 to
ea02f6c
Compare
There was a problem hiding this comment.
Automated approval for maintainer PR
All automated quality gates passed. See SECURITY_CONTROLS.md for compensating controls.
The README implied v13/v14 were the only supported versions. Add a compatibility table mapping each supported TYPO3 LTS to its extension branch, latest release, PHP floor, and maintenance status: - main (v13.4 / v14.3 LTS) — actively maintained, CKEditor 5 - TYPO3_12 (v12.4 LTS) — maintained bugfixes, CKEditor 5 - TYPO3_11 (v11.5 LTS) — end of life, CKEditor 4 - TYPO3_10 (v10.4 LTS) — end of life, CKEditor 4 Clarifies that the CKEditor 5 rewrite spans TYPO3_12 + main (matching core's CKE5 migration at v12) while v10/v11 remain on CKEditor 4. Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>
There was a problem hiding this comment.
Automated approval for maintainer PR
All automated quality gates passed. See SECURITY_CONTROLS.md for compensating controls.
|
1 participant
Summary
Restructures
README.md(+257 / −177) so the front door of the repo reads less like a feature spec and more like the entry path an integrator actually takes when landing here from a search engine.SECURITY.md.SEO keywords woven in naturally: TYPO3 CKEditor image, TYPO3 v13/v14 LTS, Rich Text Editor, File Abstraction Layer (FAL), CKEditor 5 plugin, Magic Images, inline images, Fluid templates, PSR-14.
What is not changed
Test plan
CONTRIBUTING.md,SECURITY.md,CODE_OF_CONDUCT.md,AGENTS.md, andLICENSEstill exist at the paths the README points to.