Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions mintlify-migration/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Mintlify Starter Kit

Use the starter kit to get your docs deployed and ready to customize.

Click the green **Use this template** button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with

- Guide pages
- Navigation
- Customizations
- API reference pages
- Use of popular components

**[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)**

## Development

Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:

```
npm i -g mint
```

Run the following command at the root of your documentation, where your `docs.json` is located:

```
mint dev
```

View your local preview at `http://localhost:3000`.

## Publishing changes

Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.

## Need help?

### Troubleshooting

- If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.

### Resources
- [Mintlify documentation](https://mintlify.com/docs)
- [Mintlify community](https://mintlify.com/community)
34 changes: 34 additions & 0 deletions mintlify-migration/api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: "API Reference"
sidebarTitle: "Overview"
---

<CardGroup>
<Card title="Ultra API Schema" href="/api/ultra-api" icon="folder-open" horizontal>
6 items
</Card>
<Card title="Swap API Schema" href="/api/swap-api" icon="folder-open" horizontal>
4 items
</Card>
<Card title="Lend API Schema" href="/api/lend-api" icon="folder-open" horizontal>
1 item
</Card>
<Card title="Trigger API Schema" href="/api/trigger-api" icon="folder-open" horizontal>
5 items
</Card>
<Card title="Recurring API Schema" href="/api/recurring-api" icon="folder-open" horizontal>
6 items
</Card>
<Card title="Token API Schema" href="/api/token-api" icon="folder-open" horizontal>
2 items
</Card>
<Card title="Price API Schema" href="/api/price-api" icon="folder-open" horizontal>
2 items
</Card>
<Card title="Send API Schema (Beta)" href="/api/send-api" icon="folder-open" horizontal>
4 items
</Card>
<Card title="Studio API Schema (Beta)" href="/api/studio-api" icon="folder-open" horizontal>
5 items
</Card>
</CardGroup>
10 changes: 10 additions & 0 deletions mintlify-migration/api/lend-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Lend API"
sidebarTitle: "Overview"
---

<CardGroup>
<Card title="Earn (Beta)11 items" href="/api/lend-api/earn" icon="folder-open" horizontal>
11 items
</Card>
</CardGroup>
40 changes: 40 additions & 0 deletions mintlify-migration/api/lend-api/earn.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: "Earn (Beta)"
sidebarTitle: "Overview"
---

<CardGroup>
<Card title="deposit" href="/api/lend-api/earn/deposit" icon="file-lines" horizontal>
Request for a base64-encoded unsigned earn deposit transaction to deposit assets
</Card>
<Card title="withdraw" href="/api/lend-api/earn/withdraw" icon="file-lines" horizontal>
Request for a base64-encoded unsigned earn withdraw transaction to withdraw assets
</Card>
<Card title="mint" href="/api/lend-api/earn/mint" icon="file-lines" horizontal>
Request for a base64-encoded unsigned earn mint transaction to mint shares
</Card>
<Card title="redeem" href="/api/lend-api/earn/redeem" icon="file-lines" horizontal>
Request for a base64-encoded unsigned earn redeem transaction to redeem shares
</Card>
<Card title="deposit-instructions" href="/api/lend-api/earn/deposit-instructions" icon="file-lines" horizontal>
Request for the instruction of an earn deposit transaction to deposit assets
</Card>
<Card title="withdraw-instructions" href="/api/lend-api/earn/withdraw-instructions" icon="file-lines" horizontal>
Request for the instruction of an earn withdraw transaction to withdraw assets
</Card>
<Card title="mint-instructions" href="/api/lend-api/earn/mint-instructions" icon="file-lines" horizontal>
Request for the instruction of an earn mint transaction to mint shares
</Card>
<Card title="redeem-instructions" href="/api/lend-api/earn/redeem-instructions" icon="file-lines" horizontal>
Request for the instruction of an earn redeem transaction to redeem shares
</Card>
<Card title="tokens" href="/api/lend-api/earn/tokens" icon="file-lines" horizontal>
Request for the tokens available to be deposited and their information
</Card>
<Card title="positions" href="/api/lend-api/earn/positions" icon="file-lines" horizontal>
Request for the position data of one or multiple users
</Card>
<Card title="earnings" href="/api/lend-api/earn/earnings" icon="file-lines" horizontal>
Request for the earnings of one or multiple posi
</Card>
</CardGroup>
3 changes: 3 additions & 0 deletions mintlify-migration/api/lend-api/earn/deposit-instructions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/lend/lend.yaml post /earn/deposit-instructions
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/lend-api/earn/deposit.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/lend/lend.yaml post /earn/deposit
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/lend-api/earn/earnings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/lend/lend.yaml get /earn/earnings
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/lend-api/earn/mint-instructions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/lend/lend.yaml post /earn/mint-instructions
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/lend-api/earn/mint.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/lend/lend.yaml post /earn/mint
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/lend-api/earn/positions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/lend/lend.yaml get /earn/positions
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/lend-api/earn/redeem-instructions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/lend/lend.yaml post /earn/redeem-instructions
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/lend-api/earn/redeem.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/lend/lend.yaml post /earn/redeem
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/lend-api/earn/tokens.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/lend/lend.yaml get /earn/tokens
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/lend/lend.yaml post /earn/withdraw-instructions
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/lend-api/earn/withdraw.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/lend/lend.yaml post /earn/withdraw
---
13 changes: 13 additions & 0 deletions mintlify-migration/api/price-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: "Price API"
sidebarTitle: "Overview"
---

<CardGroup>
<Card title="V3 (Beta)" href="/api/price-api/v3" icon="folder-open" horizontal>
1 item
</Card>
<Card title="V2 (Deprecated)" href="/api/price-api/v2" icon="folder-open" horizontal>
1 item
</Card>
</CardGroup>
10 changes: 10 additions & 0 deletions mintlify-migration/api/price-api/v2.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Price API V2 (Deprecated)"
sidebarTitle: "Overview"
---

<CardGroup>
<Card title="Price" href="/api/price-api/v2/price" icon="folder-open" horizontal>
Returns prices of specified tokens.
</Card>
</CardGroup>
4 changes: 4 additions & 0 deletions mintlify-migration/api/price-api/v2/price.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: /docs/openapi-spec/price/v2/price.yaml get /
deprecated: true
---
10 changes: 10 additions & 0 deletions mintlify-migration/api/price-api/v3.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Price API V3 (Beta)"
sidebarTitle: "Overview"
---

<CardGroup>
<Card title="Price" href="/api/price-api/v3/price" icon="folder-open" horizontal>
Returns prices of specified tokens.
</Card>
</CardGroup>
3 changes: 3 additions & 0 deletions mintlify-migration/api/price-api/v3/price.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/price/v3/price.yaml get /price/v3
---
25 changes: 25 additions & 0 deletions mintlify-migration/api/recurring-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Recurring API"
sidebarTitle: "Overview"
---

<CardGroup>
<Card title="createOrder" href="/api/recurring-api/create-order" icon="file-lines" horizontal>
Request for a base64-encoded unsigned recurring order creation transaction to be used in `POST /recurring/v1/execute`
</Card>
<Card title="execute" href="/api/recurring-api/execute" icon="file-lines" horizontal>
Execute the signed transaction and get the execution status
</Card>
<Card title="cancelOrder" href="/api/recurring-api/cancel-order" icon="file-lines" horizontal>
Request for a base64-encoded unsigned recurring order cancellation transaction to be used in `POST /recurring/v1/execute`
</Card>
<Card title="priceDeposit" href="/api/recurring-api/price-deposit" icon="file-lines" horizontal>
**DEPRECATED**: This endpoint is deprecated. Please use time-based recurring orders instead.
</Card>
<Card title="priceWithdraw" href="/api/recurring-api/price-withdraw" icon="file-lines" horizontal>
**DEPRECATED**: This endpoint is deprecated. Please use time-based recurring orders instead.
</Card>
<Card title="getRecurringOrders" href="/api/recurring-api/get-recurring-orders" icon="file-lines" horizontal>
Request for the active or historical orders associated to the provided account
</Card>
</CardGroup>
11 changes: 11 additions & 0 deletions mintlify-migration/api/recurring-api/cancel-order.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
openapi: /docs/openapi-spec/recurring/recurring.yaml post /cancelOrder
---

<Info>
**NOTE**

- `recurringType` is used to denote the type of recurring order, only `time`
- **DEPRECATED**: `recurringType: price` based orders are deprecated
- Refer to [Recurring API doc](/docs/recurring-api/cancel-order) for more information.
</Info>
11 changes: 11 additions & 0 deletions mintlify-migration/api/recurring-api/create-order.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
openapi: /docs/openapi-spec/recurring/recurring.yaml post /createOrder
---

<Info>
**NOTE**

- Pass in the correct recurring type in the `params` field, only `time`
- **DEPRECATED**: `params.price` based orders are deprecated
- Refer to [Recurring API doc](/docs/recurring-api/create-order) for more information.
</Info>
3 changes: 3 additions & 0 deletions mintlify-migration/api/recurring-api/execute.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/recurring/recurring.yaml post /execute
---
10 changes: 10 additions & 0 deletions mintlify-migration/api/recurring-api/get-recurring-orders.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
openapi: /docs/openapi-spec/recurring/recurring.yaml get /getRecurringOrders
---

<Info>
**NOTE**

- `recurringType` is used to denote the type of recurring order, only `time`
- **DEPRECATED**: `recurringType: price` based orders are deprecated
</Info>
4 changes: 4 additions & 0 deletions mintlify-migration/api/recurring-api/price-deposit.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: /docs/openapi-spec/recurring/recurring.yaml post /priceDeposit
deprecated: true
---
4 changes: 4 additions & 0 deletions mintlify-migration/api/recurring-api/price-withdraw.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: /docs/openapi-spec/recurring/recurring.yaml post /priceWithdraw
deprecated: true
---
19 changes: 19 additions & 0 deletions mintlify-migration/api/send-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "Send API"
sidebarTitle: "Overview"
---

<CardGroup>
<Card title="craft-send" href="/api/send-api/craft-send" icon="file-lines" horizontal>
Request for a base64-encoded unsigned Send transaction
</Card>
<Card title="craft-clawback" href="/api/send-api/craft-clawback" icon="file-lines" horizontal>
Request for a base64-encoded unsigned Send transaction
</Card>
<Card title="pending-invites" href="/api/send-api/pending-invites" icon="file-lines" horizontal>
Request for the pending invites of an address
</Card>
<Card title="invite-history" href="/api/send-api/invite-history" icon="file-lines" horizontal>
Request for the invite history of an address
</Card>
</CardGroup>
3 changes: 3 additions & 0 deletions mintlify-migration/api/send-api/craft-clawback.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/send/send.yaml post /craft-clawback
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/send-api/craft-send.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/send/send.yaml post /craft-send
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/send-api/invite-history.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/send/send.yaml get /invite-history
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/send-api/pending-invites.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/send/send.yaml get /pending-invites
---
22 changes: 22 additions & 0 deletions mintlify-migration/api/studio-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: "Studio API"
sidebarTitle: "Overview"
---

<CardGroup>
<Card title="dbc-pool-create-tx" href="/api/studio-api/dbc-pool-create-tx" icon="file-lines" horizontal>
Request for a base64-encoded unsigned transaction to create a Dynamic Bonding Curve pool with token metadata
</Card>
<Card title="dbc-pool-submit" href="/api/studio-api/dbc-pool-submit" icon="file-lines" horizontal>
Execute the signed transaction, and optionally upload content and header image
</Card>
<Card title="dbc-pool-addresses-by-mint" href="/api/studio-api/dbc-pool-addresses-by-mint" icon="file-lines" horizontal>
Request for pool addresses for a given token mint
</Card>
<Card title="dbc-fee" href="/api/studio-api/dbc-fee" icon="file-lines" horizontal>
Request for unclaimed creator trading fees of a Dynamic Bonding Curve pool
</Card>
<Card title="dbc-fee-create-tx" href="/api/studio-api/dbc-fee-create-tx" icon="file-lines" horizontal>
Request for a base64-encoded unsigned transaction to claim creator trading fees of a Dynamic Bonding Curve pool
</Card>
</CardGroup>
3 changes: 3 additions & 0 deletions mintlify-migration/api/studio-api/dbc-fee-create-tx.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/studio/studio.yaml post /dbc/fee/create-tx
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/studio-api/dbc-fee.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/studio/studio.yaml post /dbc/fee
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/studio/studio.yaml get /dbc-pool/addresses/{mint}
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/studio-api/dbc-pool-create-tx.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/studio/studio.yaml post /dbc-pool/create-tx
---
3 changes: 3 additions & 0 deletions mintlify-migration/api/studio-api/dbc-pool-submit.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: /docs/openapi-spec/studio/studio.yaml post /dbc-pool/submit
---
Loading