search

FluidTYPO3 / vhs

TYPO3 extension VHS: Fluid ViewHelpers
https://fluidtypo3.org
Other
190 stars 229 forks source link

[DOCS] Align with new TYPO3 documentation standards #1762

Closed alexander-nitsche closed 2 years ago

alexander-nitsche commented 2 years ago

Hi Claus, hi Björn, hi Cedric, hi VHS 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: The whole documentation should be rendered and deployed on docs.typo3.org - in perspective. It is currently deployed to the custom page https://viewhelpers.fluidtypo3.org/fluidtypo3/vhs/ and thus not found by the new global search at docs.typo3.org. If you need assistance on how to migrate, i would be happy to support you.

Greetings, Alex

Related: https://github.com/TYPO3-Documentation/T3DocTeam/issues/182 Related: https://github.com/TYPO3-Documentation/T3DocTeam/issues/185

alexander-nitsche commented 2 years ago

What is missing - Part 2: The documentation URL in the "External manual" field of the TER extension page is wrong by pointing to

instead of

alexander-nitsche commented 2 years ago

Ok. Rebased PR on current development branch and fixed both issues.

NamelessCoder commented 2 years ago

Perfect - thanks!