About this guide¶
How this guide is structured¶
This manual covers writing TYPO3 documentation. This includes, contributing to official documentation, the core changelog and system extensions and writing documentation for third party extensions.
It is more than just documentation: it also lists some conventions, coding guidelines and provides links to GitHub issues.
How to read this guide¶
This manual introduces you to writing TYPO3 documentation. You can read it cover-to-cover.
Specifically, you might like to look at:
Basic principles to familiarize yourself with the structure
Documentation content style guide for tips on coding guidelines, spelling etc.
Additionally, keep the Cheat sheet: reST & Sphinx handy to look up the syntax.
But often, you would like to jump right in, start with a specific task and learn as you go along. In that case, find your task here and start reading:
How to document an extension if you have an extension and would like to write documentation for it using the sample extension manual.
Workflow #1: "Edit on GitHub" if you would like to contribute to the official documentation and need an easy introduction to editing documentation directly on GitHub. This does not require any development tools, you just need a browser and a GitHub account.
Workflow #2: "Local editing and rendering with Docker" if you would like to contribute to the official documentation and are already familiar with Git and Docker
Rendering the documentation with Docker if you would like to start with rendering the documentation locally with Docker.
This document was originally written by Martin Bless.
Special thanks to Xavier Perseguers, who wrote some of the original texts in the retired TYPO3 Wiki and elsewhere. Some of the texts have been incorporated into this document or at least served as a basis.
Further chapters like Common pitfalls, Cheat sheet: reST & Sphinx, Contribute to the TYPO3 documentation, Basic principles, How to document an extension and How You Can Help were added by Sybille Peters.
A number of other people have helped by reviewing and refining the text and pointing out missing information. For more contributors, see the list of contributors on GitHub for this manual.
We thank everyone for their help and hope that good documentation about writing documentation will make it easier for others to contribute.