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/cart Standardized Documentation #2975

Open
18 tasks
Tracked by #2682
xelaint opened this issue Aug 14, 2024 · 1 comment
Open
18 tasks
Tracked by #2682

[DOCS] @daffodil/cart Standardized Documentation #2975

xelaint opened this issue Aug 14, 2024 · 1 comment
Labels
docs This issue is related to documentation package: cart @daffodil/cart
Milestone

Comments

@xelaint
Copy link
Member

xelaint commented Aug 14, 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
    • How do I retrieve the current user's cart?
    • How do I change the current cart storage mechanism for the user?
    • How do I add items user's cart?
    • How do I remove items from a user's cart?
    • How do I update the item quantity in my cart?
    • How do I change the cart driver?
    • How do I apply a promotion to my user's cart?
    • Updating a user's billing and shipping address at the same time
    • Applying a payment to the cart (probably just redirect to a payment guide)
  • State
  • Drivers
    • Hubspot
  • 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: cart @daffodil/cart labels Aug 14, 2024
@xelaint xelaint self-assigned this Aug 14, 2024
@damienwebdev
Copy link
Member

@griest024 can you think up some common tasks you can do with the cart package?

  • How do I retrieve the current user's cart?
  • How do I change the current cart storage mechanism for the user?
  • How do I add items user's cart?
  • How do I remove items from a user's cart?
  • How do I update the item quantity in my cart?
  • How do I change the cart driver?
  • How do I apply a promotion to my user's cart?

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: cart @daffodil/cart
Projects
None yet
Development

No branches or pull requests

2 participants