Skip to content

upgrade mint.json to docs.json #106

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

upgrade mint.json to docs.json #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
311 changes: 311 additions & 0 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,311 @@
{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"name": "Relay",
"colors": {
"primary": "#9e7aff",
"light": "#b194ff",
"dark": "#7e61cc"
},
"favicon": "/favicon.png",
"navigation": {
"tabs": [
{
"tab": "Documentation",
"groups": [
{
"group": "Introduction",
"pages": [
"what-is-relay"
]
},
{
"group": "Use Cases",
"pages": [
"use-cases/instant-bridging",
"use-cases/cross-chain-execution",
"use-cases/chain-abstraction"
]
},
{
"group": "Guides",
"pages": [
"guides/bridging",
"guides/swapping",
"guides/calling",
"guides/transaction-indexing",
"guides/solana",
"guides/testnet",
{
"group": "Smart Accounts",
"pages": [
"guides/smart-accounts",
"guides/erc-4337",
"guides/eip-7702"
]
},
{
"group": "Advanced",
"pages": [
"guides/just-in-time-gas",
"guides/deep-linking",
"guides/deposit-address",
"guides/hyperliquid-support"
]
}
]
},
{
"group": "How it Works",
"pages": [
"how-it-works/the-reservoir-relayer",
"how-it-works/contract-compatibility",
"how-it-works/swapping",
"how-it-works/fees",
"how-it-works/refunds",
"how-it-works/trade-types",
"how-it-works/surplus-and-shortage",
"how-it-works/mev-protection"
]
},
{
"group": "Resources",
"pages": [
"resources/supported-chains",
"resources/supported-routes",
"resources/contract-addresses",
"resources/bounties",
"resources/ofac-sanctions",
"resources/brand-assets"
]
}
]
},
{
"tab": "API Reference",
"groups": [
{
"group": "API Reference",
"pages": [
"references/api/overview",
"references/api/step-execution",
"references/api/handling-errors",
"references/api/get-chains",
"references/api/get-intents-status-v2",
"references/api/get-requests",
"references/api/get-token-price",
"references/api/get-currencies-v2",
"references/api/get-quote",
"references/api/execute",
"references/api/swap-multi-input",
"references/api/transactions-index",
"references/api/transactions-single",
{
"group": "Deprecated",
"pages": [
"references/api/execute-call",
"references/api/execute-bridge",
"references/api/execute-swap",
"references/api/get-price",
"references/api/get-config",
"references/api/get-intents-status",
"references/api/get-currencies"
]
}
]
}
]
},
{
"tab": "SDK Reference",
"groups": [
{
"group": "SDK Reference",
"pages": [
"references/sdk/getting-started",
"references/sdk/createClient",
{
"group": "Actions",
"pages": [
"references/sdk/actions/getQuote",
"references/sdk/actions/execute"
]
},
"references/sdk/adapters",
"references/sdk/api-types"
]
}
]
},
{
"tab": "UI Kit",
"groups": [
{
"group": "RelayKit",
"pages": [
"references/relay-kit/overview",
{
"group": "Hooks",
"pages": [
"references/relay-kit/hooks/getting-started",
"references/relay-kit/hooks/useQuote",
"references/relay-kit/hooks/useRelayChains",
"references/relay-kit/hooks/useRequests",
"references/relay-kit/hooks/useTokenList",
"references/relay-kit/hooks/useTokenPrice",
"references/relay-kit/hooks/useExecutionStatus"
]
},
{
"group": "UI",
"pages": [
"references/relay-kit/ui/getting-started",
"references/relay-kit/ui/relay-kit-provider",
"references/relay-kit/ui/swap-widget",
"references/relay-kit/ui/theming",
"references/relay-kit/ui/troubleshooting"
]
}
]
}
]
},
{
"tab": "Relay Protocol",
"groups": [
{
"group": "Relay Protocol",
"pages": [
"references/protocol/overview",
{
"group": "Depository",
"pages": [
"references/protocol/depository/overview",
"references/protocol/depository/architecture",
"references/protocol/depository/security",
{
"group": "Guides",
"pages": [
"references/protocol/depository/guides/integrating"
]
},
{
"group": "Contracts Reference",
"pages": [
"references/protocol/depository/contracts/Solana-Relay-Depository",
"references/protocol/depository/contracts/Evm-Relay-Depository"
]
}
]
},
{
"group": "Oracle",
"pages": [
"references/protocol/oracle/overview",
"references/protocol/oracle/architecture"
]
},
{
"group": "Hub",
"pages": [
"references/protocol/hub/overview",
"references/protocol/hub/architecture"
]
},
{
"group": "Vaults",
"pages": [
"references/protocol/vaults/overview",
"references/protocol/vaults/architecture",
"references/protocol/vaults/security",
"references/protocol/vaults/backend",
{
"group": "Guides",
"pages": [
"references/protocol/vaults/guides/bridging",
"references/protocol/vaults/guides/interacting"
]
},
{
"group": "Contracts Reference",
"pages": [
"references/protocol/vaults/contracts/RelayPoolFactory",
"references/protocol/vaults/contracts/RelayPool",
"references/protocol/vaults/contracts/RelayPoolNativeGateway",
"references/protocol/vaults/contracts/RelayBridgeFactory",
"references/protocol/vaults/contracts/RelayBridge"
]
}
]
}
]
}
]
}
]
},
"logo": {
"light": "/logo/relay-black.svg",
"dark": "/logo/relay-white.svg"
},
"api": {
"openapi": [
"https://api.relay.link/documentation/json"
],
"mdx": {
"server": [
"https://api.relay.link",
"https://api.testnets.relay.link"
]
}
},
"appearance": {
"default": "light"
},
"navbar": {
"links": [
{
"label": "Support",
"href": "https://support.relay.link/en/"
}
],
"primary": {
"type": "button",
"label": "Try Relay",
"href": "https://www.relay.link/"
}
},
"footer": {
"socials": {
"twitter": "https://twitter.com/RelayProtocol",
"discord": "https://discord.com/invite/relayprotocol"
}
},
"integrations": {
"posthog": {
"apiKey": "phc_bidXwDZgxGlWqfNtx8fhLESozcfupLUETfYB306Apmc",
"apiHost": "https://posthog.reservoir.tools"
},
"intercom": {
"appId": "b09ps4q8"
}
},
"redirects": [
{
"source": "/references/sdk/bridging/fetching-a-quote",
"destination": "/guides/bridging"
},
{
"source": "/references/sdk/bridging/executing-a-bridge",
"destination": "/guides/bridging"
},
{
"source": "/references/sdk/swapping/fetching-a-quote",
"destination": "/guides/swapping"
},
{
"source": "/references/sdk/swapping/executing-a-swap",
"destination": "/guides/swapping"
}
]
}
Loading