---
title: "Basic principles"
manual: "How to Document"
version: "main"
permalink: "https://docs.typo3.org/permalink/h2document:credits"
source: "Basics/BasicPrinciples.rst"
rendered: "2026-09-22T14:34:53+00:00"
---

# Basic principles {#credits}

TYPO3 documentation is written in **reStructuredText (reST)** and rendered to
HTML using a shared toolchain. Most documentation is hosted on
[https://docs.typo3.org](https://docs.typo3.org) and follows a common structure and style.

**Table of content**

-   [Types of documentation](https://docs.typo3.org/permalink/h2document:types-of-documentation)
-   [Rendering](https://docs.typo3.org/permalink/h2document:rendering)
-   [Contributing to official documentation](https://docs.typo3.org/permalink/h2document:contributing-to-official-documentation)
-   [Documenting your own extension](https://docs.typo3.org/permalink/h2document:documenting-your-own-extension)
-   [Help and support](https://docs.typo3.org/permalink/h2document:help-and-support)

## Types of documentation {#about-typo3-extensions}

Documentation may include:

-   Official manuals (e.g. [TYPO3 Explained](https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/Index.html#start))
-   System extension manuals
-   Core changelog entries
-   Third-party extension manuals

## Rendering {#whats-rendering}

Rendering converts `.rst` source files into styled HTML output. You can preview
docs locally using the official Docker container:

**Execute in extension root, the directory that contains your extensions composer.json**

```bash
docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
```

Open the file saved to `Documentation-GENERATED-temp/Index.html` in a
browser of your choice.

## Contributing to official documentation {#contribution-matrix}

Everyone is welcome to contribute to TYPO3’s official documentation.

Most manuals are hosted on GitHub. You can suggest changes directly by clicking
**Edit on GitHub** on any page.

For larger contributions or local editing, see the
[full contribution guide](https://docs.typo3.org/permalink/h2document:docs-contribute).

## Documenting your own extension {#doc-type-extension-manual}

To document your TYPO3 extension, create a `Documentation` folder in your
extension and add `.rst` files following the standard structure.

We provide a Docker command to get started with documenting an extension:

**Execute in extension root, the directory that contains your extension's composer.json**

```bash
docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest init
```

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

## Help and support {#get-help-on-writing-docs}

Need help with TYPO3 documentation? Join the TYPO3 Slack workspace and post your
question in the **#typo3-documentation** channel.

To register, visit:
[https://my.typo3.org/index.php?id=35](https://my.typo3.org/index.php?id=35)

For general TYPO3 support, see [https://typo3.org/help/](https://typo3.org/help/).

You can also contact the Documentation Team by email:
[documentation@typo3.org](mailto:documentation@typo3.org)