Skip to content

[DOCS] @daffodil/category Standardized Documentation #2999

@xelaint

Description

@xelaint

📄 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:

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsThis issue is related to documentationpackage: category@daffodil/category

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions