[DOCS] Align with new TYPO3 documentation standards #1158
Merged
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
github-actions
bot
added
the
dependencies
|
How it looks: |
- align README.rst, Index.rst, Includes.txt, Settings.cfg - add genindex.rst, Sitemap.rst - pose with total and monthly download rate Each TYPO3 package should show - current release version - total download rate - monthly download rate in badges. - remove outdated encoding note - insert TOCs for large pages - insert label for every page title - link terms to official TYPO3 documentation - link extensions to TER
|
Thanks @alexander-nitsche ! |
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 Benjamin, hi Bootstrap Package team,
this PR is a suggestion to align your extension documentation with the recently introduced TYPO3 documentation standards and similar extensions.
The focus is on having one central documentation at Documentation/ and reduce the README to an abstract, badges and further links to all important aspects of the extensions (TER, docs, VCS).
What is missing:
There are still two sources of documentation: It would be the best to integrate the wiki into the Documentation/ too and remove the wiki, to have all documentation in one place.
Greetings, Alex
Related: TYPO3-Documentation/T3DocTeam#182
Related: TYPO3-Documentation/T3DocTeam#185