---
title: "How to Document TYPO3"
manual: "How to Document"
version: "main"
permalink: "https://docs.typo3.org/permalink/h2document:start"
source: "Index.rst"
start: true
modified: "2026-09-14T09:38:54+00:00"
---

# How to Document TYPO3

-   *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
reStructuredText (reST).

---

**Migration**

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

[How to migrate to the new rendering](https://docs.typo3.org/permalink/h2document:migrate)

**Cheat sheet: reStructuredText**

Go tho the cheat sheet containing a quick overview on how to use reStructuredText.

[Go to the reST Cheat sheet](https://docs.typo3.org/permalink/h2document:rest-cheat-sheet)

**Edit on GitHub**

This chapter explains how to apply quick changes to the documentation
you are reading by applying the "Edit on GitHub" workflow. All you
need is a GitHub account.

[How to make quick fixes](https://docs.typo3.org/permalink/h2document:docs-contribute-github-method)

**Local rendering**

Using your local machine instead of editing documentation on GitHub has
many advantages, it includes the freedom to choose which IDE you make
your changes in and it also gives you the ability to experiment and
preview your changes locally before submitting them for approval.

[How to work locally with documentation](https://docs.typo3.org/permalink/h2document:docs-contribute-git-docker)

**Extension documentation**

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

[How to document an extension](https://docs.typo3.org/permalink/h2document:write-doc-extensions-intro)

**System Extensions**

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

[How to document system extensions](https://docs.typo3.org/permalink/h2document:contribute-to-system-extension)