Create documentation

[theimerj]

Create documentation

Automatic documentation

• [ ] Automatically generate OpenAPI Spec somehow
• [ ] Set up automatic build & deployment of the docs (Vitepress? Docus?)

Manual documentation

• [x] Start with Wiki
• [x] Create Postman request collection

Main functionality

Configuration

• [ ] General configuration
• [ ] HashIds
• [ ] Swap extended classes in lunar-api.domains config file
• [ ] Atomic swapping (Requests in Controllers etc.)

Domains

• [ ] Addresses
  • [ ] Billing vs Shipping Address
  • [ ] Blank Addresses created with Cart
• [ ] AttributeGroups
• [ ] Attributes
• [ ] Brands
• [ ] Carts
  • [ ] Add to Cart
  • [ ] Update quantity
  • [ ] Remove from Cart
  • [ ] Checkout Cart
• [ ] CollectionGroups
• [ ] Collections
• [ ] Countries
• [ ] Currencies
• [ ] Customers
  • [ ] Customers vs Users
• [ ] Discounts
• [ ] Media
• [ ] Orders
  • [ ] Create PaymentIntent
• [ ] PaymentOptions
  • [ ] Get PaymentOptions for Cart
• [ ] Payments
  • [ ] PaymentRegister
  • [ ] PaymentAdapter
• [ ] Prices
• [ ] ProductAssociations
  • [ ] Cross sell vs upsell
• [ ] ProductOptions
• [ ] ProductTypes
• [ ] Products
  • [ ] Composable Products
• [ ] ProductVariants
• [ ] Shipping
• [ ] Tags
• [ ] Urls
• [ ] Users
• [ ] Transactions

Integrations

Payment options

• [ ] Stripe
• [ ] Paypal
• [ ] Mollie

Compatible packages

• [ ] Product reviews (lunar-api-reviews)
• [ ] Product notifications (lunar-api-product-notifications)
• [ ] Product views (lunar-api-product-views)
• [ ] Newsletter signup (lunar-api-newsletter)
• [ ] How to write compatible package
  • [ ] Extending lunar-api JSON:API Schemas
  • [ ] Extending lunar-api JSON:API Resources

Additional Lunar Hub fields

• [ ] Multiselect
• [ ] Datepicker

Contribution

• [ ] Contribution guide

Credits

• [ ] Credits to lunarphp team
• [ ] Credits to all contributors

Form

• [ ] Vitepress
  • [ ] Deploy

[theimerj]

• [x] Look into using https://nuxt.studio/themes/docus

[theimerj]

• [ ] Look into using redocly