Project

General

Profile

Actions

Task #95816

closed

Add README.rst as "about" file to system extensions

Added by Sybille Peters about 3 years ago. Updated about 2 years ago.

Status:
Closed
Priority:
Should have
Assignee:
Category:
Documentation
Target version:
-
Start date:
2021-10-29
Due date:
% Done:

100%

Estimated time:
TYPO3 Version:
11
PHP Version:
Tags:
Complexity:
Sprint Focus:

Description

Add files README.rst to system extensions to show links, e.g.

  • to documentation
  • to contribution guide
  • etc.

This is already done in "official documentation", e.g. https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-CoreApi/blob/master/README.rst

Advantage: On GitHub or Packagist, the content of this README.rst is displayed, can link to documentation etc.

see example adminpanel currently:

Actions

Also available in: Atom PDF