FriendsOfTYPO3 / rtehtmlarea

Further maintenance of the HTMLArea RTE, previously part of the TYPO3 Core
https://typo3.org/
GNU General Public License v2.0
9 stars 19 forks source link

This extension contains documentation in Readme.rst and Documentation folder #37

Closed sypets closed 4 years ago

sypets commented 5 years ago

I realize this is happening with a lot of extensions but I find it a little unfortunate.

People who visit GitHub see the Readme. People who visit docs.typo3 see the rendered documentation in Documentation. Which is up-to-date? Which should people contribute to.

What some other extensions do, is just provide a short Readme and then link to the generated documentation on docs.typo3.org.

You can - of course - do whatever you want.

liayn commented 4 years ago

What did you identify as documentation in the readme here? For me this rather reads like a general project description.

liayn commented 4 years ago

@sypets ping