[DOCS] Update docs #192
Merged
[DOCS] Update docs #192
Conversation
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
- move status badges to top to align with similar extensions - replace TYPO3 compatibility text with compatibility badges to shrink the vertical space - use common title pattern "TYPO3 extension " to make the context of this application clear at first glance - align abstract text with abstract text of Documentation/Index.rst - link to other involved extensions of the TYPO3 universe - add table with links in prominent place to guide reader to next steps (full documentation and installation) - treat TER page as homepage of project instead of Packagist page as the former also links to Packagist
- remove deprecated t3author and description properties - include footer links to the TER page for installation and contact to conveniently guide the reader to all aspects of the extension - remove unused and update used intersphinx mappings
- rename Includes.txt to Includes.rst.txt to support reST syntax highlighting in the IDE - use absolute path of Includes.rst.txt to harmonize inclusion in all reST files
- fix reST syntax of "linkCheckingOnTheFly" label - cross-reference "columns-input-properties-softref" label in foreign TCA manual - replace unknown code-block language "tsconfig" adequately - header underlinings must have at least the same length as the header text - fix duplicate "tsconfigMailLanguage" label adequately - use proper commenting in Sitemap.rst
- align abstract text with abstract text of README.md - use HTTPS in TYPO3 URL
|
Hi @alexander-nitsche thank you so much for your work! I already noticed you streamlined and improved some standards and conventions but I must admit I am not aware of all the latest and greatest. I will have a look ... (may take a bit but will try to find time today). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi Sybille,
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.
It further fixes some reST formattings and some configurations to increase contributions to the extension.
Greetings, Alex
Related: TYPO3-Documentation/T3DocTeam#182