Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] @daffodil/category Standardized Documentation #2999

Open
12 tasks
Tracked by #2682
xelaint opened this issue Aug 19, 2024 · 0 comments
Open
12 tasks
Tracked by #2682

[DOCS] @daffodil/category Standardized Documentation #2999

xelaint opened this issue Aug 19, 2024 · 0 comments
Labels
docs This issue is related to documentation package: category @daffodil/category
Milestone

Comments

@xelaint
Copy link
Member

xelaint commented Aug 19, 2024

📄 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 xelaint added docs This issue is related to documentation package: category @daffodil/category labels Aug 19, 2024
@xelaint xelaint added this to the Daffodil v1.0 milestone Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is related to documentation package: category @daffodil/category
Projects
None yet
Development

No branches or pull requests

1 participant