GitLab

These 2 documentation related things are outdated:

Although I uploaded a manual, it is not displayed at docs.typo3.org - why?

I have problems with the reST format to document my extension - where can I get help?

In general, it would be good to point people to docs.typo3.org, so we can keep this information updated ourselves. Just let us know, what is missing.

outdated:

1. In addition you can use the extension sphinx to proof if everything is fine on your local system

   Using the Docker image for local rendering is the recommended method. See https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/RenderingDocs/Index.html

   Additionally, you can create a documentation-draft branch which will automatically be rendered as draft (not indexed by search engines).

2. That is ./Documentation/Index.rst or ./README.rst.

   Can also be any of: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/GeneralConventions/DirectoryFilenames.html#supported-filenames-and-formats

3. Rendering takes time. The documentation is fetched cyclically by docs server

   No longer true. Rendering is triggered by Webhook.

4. To get an introduction to reStructuredText take the sphinx extension as an example. Further more the format is well documented at sphinx-doc.org/rest.html. In addition the documentation of the sphinx extension has further information.

   Best to point people to our official docs: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/Index.html

5. On the page https://docs.typo3.org/Extensions/ you get a list of tools and worflows how to best document your extension in reST.

   This page no longer exists (404). I don't know what used to be on there. I think it is best to point them to https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/Index.html# for general information about reST and to https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingDocForExtension/Index.html for extension documentation.