Api.typo3.org: Replace Doxygen with phpDocumentor

by Lina Wolf

What is your idea about?
The current doxagen API at ‪TYPO3CMS: ‪TYPO3 CMS has a very outdated look and feel. It is not integrated with out Documentation or GitHub.

We want to replace doxygen regenerated api documentation with phpDocumentor to continue the process of improving the TYPO3 documentation. Which is matching the look and feel of the rest of the new php-rendered documentation. The new documentation will cover the class api docs extracted from the TYPO3 code. And will be rebuild on every change of the code base so it’s always up-to-date with the latest version of the code, following the TYPO3 version releases.

What do you want to achieve by the end of Q3 2024?

Deliver a workflow that can be executed in github generating the documentation. A customized theme, and deployed to the typo3 servers.

What is the potential impact of your idea for the overall goal?

Having a PHP based documentation tool will allow us to customize the documentation easier, which allows us to have internlinks between the documentation, GitHub and API docs, making the documentation even more valuable for our users.

Which budget do you need for your idea?
3.000 Euro

Please note: After the start of the voting we can not change the idea description nor the idea outcome. If this idea is selected by the members, it must be archived as described.

5 Likes