daffodil icon indicating copy to clipboard operation
daffodil copied to clipboard

[DOCS] `@daffodil/category` Standardized Documentation

Open xelaint opened this issue 1 year ago • 0 comments

:page_facing_up: Documentation Request

What were you doing?

Documentation for packages are not uniform and extensive enough.

Expected behavior

  • [ ] Overview: What is the package's purpose? How do I install and use this package?
    • [ ] Short paragraph explaining package's purpose
    • [ ] Installation
  • [ ] Usage
    • [ ] Applying filters to a collection of items within a category.
    • [ ] Identifying which filters are currently applied to a category.
    • [ ] Viewing the applied filters immediately without waiting for a response from a backend platform.
  • [ ] Drivers
    • [ ] Magento
    • [ ] In-memory
  • [ ] Configuration
  • [ ] Testing

Existing Documentation

Environment


Daffodil version: X.Y.Z
Angular version: X.Y.Z 

 
For Tooling issues:
- Node version: XX  
- Platform:  

Others:

xelaint avatar Aug 19 '24 18:08 xelaint