pixelant / pxa_product_manager

Product Manager. Allow to create and list products on a site. Create dynamical attributes for products. Filter by categories and attributes
11 stars 13 forks source link

[TASK] Move documentation from README to Documentation/ #351

Closed alexander-nitsche closed 2 years ago

alexander-nitsche commented 2 years ago

Currently the documentation is split: The major part is residing in the files of Documentation/ and a small part is situated at the README file. Collect all documentation in one place to always provide all information to the reader. I suggest

  1. to move all documentation from README sections "Developing the extension" and below to the Documentation/ files and
  2. to reduce the README.md to documentation abstract and the redirecting links to repository, rendered docs and TER like

    # TYPO3 Extension `pxa_product_manager`
    
    The Pixelant Product Manager allows your TYPO3 instance to display products with many filtering and sorting options.
    
    | **Repository:**  | https://github.com/pixelant/pxa_product_manager                    |
    | **Read online:** | https://docs.typo3.org/p/pixelant/pxa-product-manager/master/en-us |
    | **TER:**         | https://extensions.typo3.org/extension/pxa_product_manager         |