a-r-m-i-n / min

TYPO3 CMS extension "min" - Compressed CSS, JS and HTML output for TYPO3
7 stars 8 forks source link

[DOCS] Adapt README file #1

Closed alexander-nitsche closed 2 years ago

alexander-nitsche commented 2 years ago

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

alexander-nitsche commented 2 years ago

Hi Armin, just became aware of your documentation rendering request today and looked by. I recommend some changes to the README file. Besides that, you might want to adapt the link in your TER page where the button "Extension Manual" links to the old documentation at https://docs.typo3.org/typo3cms/extensions/min/.

a-r-m-i-n commented 2 years ago

Hi Alexander, I don't want to change the root README file to rst. I'm only using rst in favoure of the documentation team infrastructure, not because I'm a fan of. I handle it in all of my extensions, like that.

But thanks for your content improvments, I will add them to current markdown version.

I also recognized, that the link is pointing to the old version, but I thought, this will update automatically, because I did not add any link to docs by myself. I'll ask the documentation team on typo3.slack.com

a-r-m-i-n commented 2 years ago

Oh... I just double checked it, now the link in TER works.

a-r-m-i-n commented 2 years ago

I'm going to close this pull request, because I've applied your content suggestions, in a separate commit.

alexander-nitsche commented 2 years ago

Ok, sure. I would remove the "Documentation" section in your current README.md as it seems to be a duplicate of the "Links" section.

a-r-m-i-n commented 2 years ago

Documentation worth to be mentioned twice! ;-)

alexander-nitsche commented 2 years ago

Aye, no further remarks then :)