This repository has been archived by the owner on Dec 17, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
4 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,5 @@ | ||
=============================== | ||
TYPO3 Extension Manual Template | ||
=============================== | ||
.. warning:: | ||
This repository is archived. Use the init command of the Docker rendering | ||
containter to generate to create a new documentation guide instead. | ||
|
||
This is a template for a TYPO3 extension manual to help developers with | ||
documentation. The template provides a structure that a developer can use, | ||
as well as many useful snippets and examples. | ||
|
||
The documentation is written in reST format and follows the general | ||
`TYPO3 documentation standard`_ and its recommended `file structure`_. | ||
|
||
.. Documentation is like gift wrapping, it may look superfluous, | ||
but your friends tend to be rather disappointed when their presents | ||
arrive in supermarket carrier bags. | ||
:Repository: https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual | ||
:Read online: https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/ | ||
|
||
.. _TYPO3 documentation standard: https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/ | ||
.. _file structure: https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html | ||
`How to document an extension <https://docs.typo3.org/permalink/h2document:write-doc-extensions-intro>`_ |