docs: redesign tables (#8653)

* docs: redesign tables

* fixes
This commit is contained in:
Shahed Nasser
2024-08-20 14:47:36 +02:00
committed by GitHub
parent 73905c14b1
commit b8ba020cd5
33 changed files with 226 additions and 208 deletions
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted API key
id,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted auth identity
id,
@@ -76,7 +76,7 @@ const modules = {
</Table.Cell>
<Table.Cell>
```ts noCopy noReport noLineNumbers
```ts blockStyle="inline"
const hashConfig = {
logN: 15,
r: 8,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted cart
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted address
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted line item
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted line item adjustment
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted line item tax line
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted shipping method
id,
@@ -154,7 +154,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted shipping method adjustment
id,
@@ -176,7 +176,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted shipping method tax line
id,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted currency
id,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted customer
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted address
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted customer group
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted customer group customer
id,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the fulfillment set
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted fulfillment set
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the service zone
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted service zone
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the geo zone
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted geo zone
id,
@@ -154,7 +154,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the shipping option
id,
@@ -176,7 +176,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the shipping profile
id,
@@ -198,7 +198,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the shipping option rule
id,
@@ -220,7 +220,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the shipping option type
id,
@@ -242,7 +242,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the fulfillment provider
id,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the inventory item
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the inventory item
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted inventory item
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the inventory level
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the inventory level
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted inventory level
id,
@@ -154,7 +154,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the reservation item
id,
@@ -176,7 +176,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the reservation item
id,
@@ -198,7 +198,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted reservation item
id,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted order
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted address
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted line item
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted line item adjustment
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted line item tax line
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted shipping method
id,
@@ -154,7 +154,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted shipping method adjustment
id,
@@ -176,7 +176,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted shipping method tax line
id,
@@ -198,7 +198,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted transaction
id,
@@ -220,7 +220,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted order change
id,
@@ -242,7 +242,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted order change action
id,
@@ -264,7 +264,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted order item
id,
@@ -286,7 +286,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted order summary
id,
@@ -308,7 +308,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted order shipping method
id,
@@ -79,8 +79,6 @@ To check the outstanding amount of the order, its transaction amounts are summed
</Table.Body>
</Table>
---
## Transaction Reference
The Order Module doesnt provide payment processing functionalities, so it doesnt store payments that can be processed. Payment functionalities are provided by the [Payment Module](../../payment/page.mdx).
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted payment
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted payment collection
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted payment session
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted capture
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted refund
id,
@@ -93,8 +93,6 @@ In this document, you'll learn about the options of the Payment Module.
</Table.Body>
</Table>
---
## providers
The `providers` option is an array of payment module providers.
@@ -197,8 +197,6 @@ STRIPE_API_KEY=<YOUR_STRIPE_API_KEY>
</Table.Body>
</Table>
---
## Use Provider
To use the Stripe provider, create a payment session for the provider:
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted price set
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted price list
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted price list rule
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted price list rule value
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted price rule
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted price
id,
@@ -154,7 +154,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted price set rule type
id,
@@ -176,7 +176,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted rule type
id,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the product
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the product
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted product
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the product collection
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the product collection
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted product collection
id,
@@ -154,7 +154,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the product category
id,
@@ -176,7 +176,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the product category
id,
@@ -198,7 +198,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted product category
id,
@@ -220,7 +220,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted product option
id,
@@ -242,7 +242,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted product tag
id,
@@ -264,7 +264,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted product type
id,
@@ -286,7 +286,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted product variant
id,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted promotion
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted application method
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted campaign
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted campaign budget
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted promotion rule
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted promotion rule value
id,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted region
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted country
id,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted sales channel
id,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted stock location
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted stock location address
id,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted store
id,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted tax rate
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted tax region
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted tax rate rule
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted tax provider
id,
@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the user
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the user
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted user
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the invite
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the invite
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted invite
id,
@@ -154,7 +154,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the invite
id,