README.rst or README.md

Full documentation contains both a README.rst and a Documentation/Index.rst file. To avoid redundancy in both places, the README.rst in this case usually contains only a summary and links to all aspects of the project, i.e. the VCS repository, the published documentation and - if available - the TYPO3 Extension Repository (TER) page to guide the reader to the next steps. This could be for example:

Documentation/README.rst 
<badges>

=========
<project>
=========

<abstract>

:Repository:  https://<vcs-repository>
:Read online: https://docs.typo3.org/p/<package-name>/main/en-us/
:TER:         https://extensions.typo3.org/extension/<extension-key>/
Copied!
Documentation/Index.rst of the Examples extension manual 
.. include:: /Includes.rst.txt
.. _start:

================================
Core documentation code examples
================================

:Language:
     en

:Version:
   |release|

:Description:
     General TYPO3 CMS code examples. Used in particular for maintaining the official documentation.

:Keywords:
     examples, tutorial, documentation

:Copyright:
     2013-2021

:Author:
     TYPO3 Documentation Team

:Email:
     documentation@typo3.org

:License:
   This document is published under the Open Content License
   available from http://www.opencontent.org/opl.shtml

:Rendered:
   |today|


.. toctree::
   :titlesonly:

   Introduction/Index
   Users/Index
   Maintainers/Index
Copied!
Documentation/Index.rst of the Dashboard manual 
.. include:: /Includes.rst.txt
..  _start:

===============
TYPO3 Dashboard
===============

:Extension key:
   dashboard

:Package name:
   typo3/cms-dashboard

:Version:
   |release|

:Language:
   en

:Author:
   TYPO3 contributors

:License:
   This document is published under the
   `Open Content License <https://www.openhub.net/licenses/opl>`__.

:Rendered:
   |today|

----

This TYPO3 backend module is used to configure and create backend widgets.

----

**Table of Contents:**

.. toctree::
   :maxdepth: 2
   :titlesonly:

   Introduction/Index
   Installation/Index
   Editor/Index
   Configuration/Index
   Developer/Index
   Widgets/Index

.. Meta Menu

.. toctree::
   :hidden:

   Sitemap
   genindex
Copied!
Documentation/Index.rst of the Getting Started tutorial 
.. include:: /Includes.rst.txt
..  _start:

================================
TYPO3 - Getting Started Tutorial
================================

Welcome to Getting Started, this guide features an introduction to TYPO3 that
highlights some of its core concepts including the backend administrative
interface.

This guide also contains information on how to configure the host operating
system and features a detailed installation guide that explains how TYPO3 is
installed.

----

.. 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:`Concepts <Concepts>`

         .. container:: card-body

            Written for new users, this chapter introduces some of TYPO3s core concepts including the backend, TYPO3s administration interface.

   .. 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:`System Requirements <System-Requirements>`

         .. container:: card-body

            System requirements for the host operation system, including its web server and database and how they should be configured prior to installation.

   .. 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:`Installation <Install>`

         .. container:: card-body

            The installation chapter provides detailed instructions about how to install TYPO3, it also contains information about how to deploy TYPO3 to a production environment.

   .. 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:`Setup <Setup>`

         .. container:: card-body

            Setup aims to guide you through the next steps post installation. Such as adding domains, setting up additional users and configuring languages.

   .. 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:`Troubleshooting <troubleshooting_index>`

         .. container:: card-body

            Troubleshoot common issues that can occur during installation. The Troubleshooting chapter covers both TYPO3 CMS and the host environment including the web server, database and PHP.

   .. 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:`Managing Backend Users <user-management>`

         .. container:: card-body

            Learn how to create users and configure their backend privileges.

   .. 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:`Working With Extensions <extensions_index>`

         .. container:: card-body

            Discover how third-party extensions are installed and managed using Composer.

   .. 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:`The Introduction Package <introductionpackage_index>`

         .. container:: card-body

            The Introduction Package is a great place to start if you are looking to test drive TYPO3 and see a prebuilt site that contains
            a range of example page templates and content.


   .. 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:`Next Steps <next-steps>`

         .. container:: card-body

            Next Steps provides an overview of tasks that can be carried out once TYPO3 is installed, such as creating templates and adding content.

.. Table of Contents

.. toctree::
  :hidden:
  :titlesonly:

  Concepts/Index
  SystemRequirements/Index
  Installation/Index
  Setup/Index
  Troubleshooting/Index
  Extensions/Index
  UserManagement/Index
  IntroductionPackage/Index
  NextSteps/Index

----

:Version:
   |release|

:Language:
   en

:Author:
   TYPO3 contributors

:License:
   This document is published under the
   `Open Publication License <https://www.opencontent.org/openpub/>`__.

:Rendered:
   |today|

.. Meta Menu

.. toctree::
   :hidden:

   Sitemap
   genindex
Copied! 
<badges>

# <project>

<abstract>

|                  | URL                                                           |
|------------------|---------------------------------------------------------------|
| **Repository:**  | https://<vcs-repository>                                      |
| **Read online:** | https://docs.typo3.org/p/<package-name>/main/en-us/           |
| **TER:**         | https://extensions.typo3.org/extension/<extension-key>/       |
Copied!

Badges

Point out interesting statistics of your extension or package in the badges placeholder, which may include the latest release version, the total and monthly download rate and the supported TYPO3 versions:

Documentation/README.rst 
..  image:: https://poser.pugx.org/<package-name>/v/stable
    :alt: Latest Stable Version
    :target: https://extensions.typo3.org/extension/<extension-key>/

..  image:: https://img.shields.io/badge/TYPO3-11-orange.svg
    :alt: TYPO3 11
    :target: https://get.typo3.org/version/11

..  image:: https://poser.pugx.org/<package-name>/d/total
    :alt: Total Downloads
    :target: https://packagist.org/packages/<package-name>

..  image:: https://poser.pugx.org/<package-name>/d/monthly
    :alt: Monthly Downloads
    :target: https://packagist.org/packages/<package-name>
Copied!
Documentation/README.md 
[![Latest Stable Version](https://poser.pugx.org/<package-name>/v/stable)](https://extensions.typo3.org/extension/<extension-key>/)
[![TYPO3 11](https://img.shields.io/badge/TYPO3-11-orange.svg?style=flat-square)](https://get.typo3.org/version/11)
[![Total Downloads](https://poser.pugx.org/<package-name>/d/total)](https://packagist.org/packages/<package-name>)
[![Monthly Downloads](https://poser.pugx.org/<package-name>/d/monthly)](https://packagist.org/packages/<package-name>)
Copied!

Remove this field if the project is no extension or package.

Project

The project placeholder contains the title of the project.

Common values are, for example, in the official TYPO3 manuals

  1. <Topic> Guide, e.g. "Installation and Upgrade Guide", for collections of articles on a specific topic
  2. <Topic> Reference, e.g. "TCA Reference", for a complete encyclopedia
  3. <Topic> Tutorial, e.g. "Getting Started Tutorial", for collections of tutorials on a specific topic

and in TYPO3 system and third-party extensions

  • TYPO3 extension <extension-key>, e.g. "TYPO3 extension ``extbase``" and "TYPO3 extension ``mask``".

Abstract

The abstract placeholder contains a short and precise description of the project with as many keywords as possible in as few sentences as possible. It helps the decision maker to quickly decide whether the project is worth considering and whether or not to read the full documentation. It should be aligned with the abstract of Index.rst and - if available - the description fields of ext_emconf.php and composer.json.