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.

Sign up for GitHub

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

Jump to bottom

Create documentation #11

Open
2 of 65 tasks
Tracked by #108
repl6669 opened this issue Jun 15, 2023 · 2 comments
Open
2 of 65 tasks
Tracked by #108

Create documentation #11

repl6669 opened this issue Jun 15, 2023 · 2 comments
Assignees
@repl6669
Labels
documentation Improvements or additions to documentation
Milestone
v1.0

Comments

@repl6669
Copy link
Contributor

repl6669 commented Jun 15, 2023 •
edited
Loading

Create documentation

Automatic documentation

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

Manual documentation

  • Start with Wiki
  • 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

Compatible packages

Additional Lunar Hub fields

Contribution

  • Contribution guide
  • Naming conventions

Credits

Form

  • Vitepress
    • Deploy
@repl6669 repl6669 added the documentation Improvements or additions to documentation label Jun 15, 2023
@repl6669 repl6669 added this to the Initial release milestone Jun 15, 2023
@repl6669
Copy link
Contributor Author

repl6669 commented Jul 20, 2023 •
edited
Loading

@repl6669 repl6669 self-assigned this Oct 19, 2023
@repl6669 repl6669 mentioned this issue Feb 9, 2024
Closed
@repl6669 repl6669 pinned this issue Feb 9, 2024
@repl6669
Copy link
Contributor Author

repl6669 commented Feb 9, 2024

@repl6669 repl6669 mentioned this issue May 8, 2024
Open
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@repl6669 repl6669

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v1.0
Development

No branches or pull requests
1 participant
@repl6669