Closed alexander-nitsche closed 2 years ago
How it looks:
Thanks for your work @alexander-nitsche!
Is there a way to avoid converting the changelog MD files? These are both automatically generated and have permalinks in various places (which are outside our control). I would even be OK with the changelog item just being a link to the GitHub listing of the MD files.
No problem. The TYPO3 Sphinx theme supports Markdown in a reduced way, which is almost fine for the changelogs (only problem are the links to the diff view of the patch). It is still important to have the changelog integrated into the full documentation so that i added a note about rendering flaws and that the user could navigate to the GitHub view in doubt (amended in commit "[DOCS] Integrate changelog into full documentation").
Still a minor problem - the changelog index is also automatically generated as MD - and it looks like the files in Documentation/Classes were dropped without conversion?
In the first step the README.md was aligned to the documentation standards and published at docs.typo3.org. In this second step the documentation is transformed into a full documentation, making use of all advantages of the TYPO3 Sphinx theme and being searchable by the global search on docs.typo3.org.
What remains: Rendering the view helper documentation automatically into the Documentation/ViewHelpers/ folder.