.. include:: /Includes.rst.txt
..  _start:
.. index:: ! Writing documentation

=====================
Writing documentation
=====================

:Version:
   |release|

:Language:
   en

:Author:
   TYPO3 contributors

:License:
   This document is published under the
   `Creative Commons BY 4.0 <https://creativecommons.org/licenses/by/4.0/>`__
   license.

:Rendered:
   |today|

----

This guide contains information about contributing to TYPO3 documentation,
writing documentation for TYPO3 extensions and formatting with
reST and Sphinx.

----

.. container:: row m-0 p-0

   .. container:: col-md-6 pl-0 pr-3 py-3 m-0

      .. container:: card px-0 h-100

         .. rst-class:: card-header h3

            .. rubric:: :ref:`Migration <migrate>`

         .. container:: card-body

            Migrate your documentation to the new, PHP-based reST rendering.

.. container:: row m-0 p-0

   .. container:: col-md-6 pl-0 pr-3 py-3 m-0

      .. container:: card px-0 h-100

         .. rst-class:: card-header h3

            .. rubric:: `Extension Documentation <https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/WritingDocForExtension/Index.html>`__

         .. container:: card-body

            This chapter explains how to write documentation for a new extension.

   .. container:: col-md-6 pl-0 pr-3 py-3 m-0

      .. container:: card px-0 h-100

         .. rst-class:: card-header h3

            .. rubric:: `TYPO3 Documentation <https://docs.typo3.org/>`__

         .. container:: card-body

            Explains how you can contribute and help improve TYPO3's documentation.

   .. container:: col-md-6 pl-0 pr-3 py-3 m-0

      .. container:: card px-0 h-100

         .. rst-class:: card-header h3

            .. rubric:: `System Extensions <https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/WritingDocForExtension/ContributeToSystemExtension.html>`__

         .. container:: card-body

            The chapter contains information on how you can make changes to system extension documentation.

   .. container:: col-md-6 pl-0 pr-3 py-3 m-0

      .. container:: card px-0 h-100

         .. rst-class:: card-header h3

            .. rubric:: `Third-party Extensions <https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/WritingDocForExtension/ContributeToThirdPartyExtension.html>`__

         .. container:: card-body

            This chapter explains how you can about making changes to third-party extension documentation.

.. toctree::
   :hidden:
   :caption: BASICS

   About
   HowToGetHelp
   BasicPrinciples
   GeneralConventions/Index
   WritingReST/Index

.. toctree::
   :hidden:
   :caption: HOWTOS

   Migration/Index
   WritingDocForExtension/Index
   WritingDocsOfficial/Index
   RenderingDocs/Index

.. toctree::
   :hidden:
   :caption: ADVANCED

   HowToAddTranslation/Index
   GeneralConventions/ReviewInformation

.. toctree::
   :hidden:
   :caption: MAINTAINERS

   Maintainers/Index

.. Meta Menu

.. toctree::
   :hidden:

   Sitemap