[DOCS] Update documentation #2
Conversation
- use common template for TYPO3 extensions - add links for next steps: full documentation and installation at TER
|
hi pièrre, i just came across your extension documentation while having a look at intercept. this pr is to align with similar documentations, that want to improve the guiding of the user. it provides him or her with all required information, especially with links to the next steps like installation and full documentation. i further fixed some reST formattings and some configurations to increase contributions to your extension. two todos remain nevertheless: (1) you should consider to elaborate in more detail, what your extension does:
(2) and you should add the GitHub repository URL in the TER configuration of your extension, so that the TER page shows the "Code Insights" button on the right side column. |
- increase contribution by providing editing via GitHub UI on-the-fly (`github_*` properties) - add links to aspects of the project other than the documentation, e.g. contact details, project page in TER, VCS repository and issues (`project_*` properties) - disable unused intersphinx mappings - remove always-active youtube extension section
- rename Includes.txt to Includes.rst.txt to support associating reST syntax highlighting with this file extension in your IDE - refer to absolute instead of relative path of Includes.rst.txt to harmonize the inclusion statement - fix too short underlining of headers - add abstract to Index.rst - remove unused subpages from Index.rst - insert empty line in code-block directive between declaration and code, see https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/WritingReST/Codeblocks.html
|
Thx for the commit. We will add more informations about the extension later. |
Related: TYPO3-Documentation/T3DocTeam#182