Skip to content

Commit 1424f55

Browse files
VGabriel45VGabriel45
authored
feat: re-structure SDK docs (#35)
* feat: re-structure SDK docs * refactor: added batch tx example * refactor: removed wallet connectors * fix: broken links
1 parent c1fb2d5 commit 1424f55

31 files changed

+609
-638
lines changed

‎api-references/transactions/overview.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Meta-transactions are the idea of a transaction inside of a transaction. The ben
1717

1818
The best part: transactions with Sequence Transactions API are compatible with any existing/deployed Ethereum contract, and thus, integrating the Sequence Relayer doesn't require any changes to your contracts or dapp.
1919

20-
The Sequence Transactions API is usable by frontend dapps, or even in your backends. Be sure to install the corresponding SDK for your preferred language such as [Typescript](/sdk/typescript/guides/overview) or [Go](/sdk/go/overview).
20+
The Sequence Transactions API is usable by frontend dapps, or even in your backends. Be sure to install the corresponding SDK for your preferred language such as [Typescript](/sdk/typescript/overview) or [Go](/sdk/go/overview).
2121

2222
## Anatomy of a Sequence transaction bundle
2323

‎docs.json

+42-58
Original file line numberDiff line numberDiff line change
@@ -228,60 +228,7 @@
228228
]
229229
},
230230
{
231-
"group": "SDK",
232-
"pages": [
233-
{
234-
"group": "Headless Embedded Wallet",
235-
"pages": [
236-
"sdk/headless-wallet/quickstart",
237-
"sdk/headless-wallet/authentication",
238-
"sdk/headless-wallet/use-wallets",
239-
"sdk/headless-wallet/account-federation",
240-
"sdk/headless-wallet/manage-sessions",
241-
"sdk/headless-wallet/on-ramp",
242-
"sdk/headless-wallet/fee-options",
243-
"sdk/headless-wallet/verification",
244-
"sdk/headless-wallet/transaction-receipts"
245-
]
246-
},
247-
{
248-
"group": "Typescript",
249-
"pages": [
250-
"sdk/typescript/guides/overview",
251-
"sdk/typescript/guides/connect-wallet",
252-
"sdk/typescript/guides/auth-address",
253-
"sdk/typescript/guides/sign-message",
254-
"sdk/typescript/guides/session-keys",
255-
"sdk/typescript/guides/send-transaction",
256-
"sdk/typescript/guides/send-erc20",
257-
"sdk/typescript/guides/send-erc721",
258-
"sdk/typescript/guides/send-erc1155",
259-
"sdk/typescript/guides/send-batch-transactions",
260-
"sdk/typescript/guides/building-backends",
261-
{
262-
"group": "Wallet Connectors",
263-
"pages": [
264-
"sdk/typescript/connectors/overview",
265-
"sdk/typescript/connectors/wagmi",
266-
"sdk/typescript/connectors/rainbow-kit",
267-
"sdk/typescript/connectors/web3-onboard",
268-
"sdk/typescript/connectors/web3-react-v6",
269-
"sdk/typescript/connectors/web3modal",
270-
"sdk/typescript/connectors/FAQ"
271-
]
272-
}
273-
]
274-
},
275-
{
276-
"group": "Go",
277-
"pages": [
278-
"sdk/go/overview"
279-
]
280-
}
281-
]
282-
},
283-
{
284-
"group": "Game Engine",
231+
"group": "Game Engine SDKs",
285232
"pages": [
286233
{
287234
"group": "Unity",
@@ -389,10 +336,47 @@
389336
]
390337
},
391338
{
392-
"group": "Mobile",
393-
"pages": [
394-
"sdk/mobile"
395-
]
339+
"group": "Other SDKs",
340+
"pages": [
341+
{
342+
"group": "Typescript",
343+
"pages": [
344+
"sdk/typescript/overview",
345+
{
346+
"group": "Backend Integration",
347+
"pages": [
348+
"sdk/typescript/guides/backend/integration"
349+
]
350+
},
351+
{
352+
"group": "Frontend Integration",
353+
"pages": [
354+
"sdk/headless-wallet/quickstart",
355+
"sdk/headless-wallet/authentication",
356+
"sdk/headless-wallet/use-wallets",
357+
"sdk/headless-wallet/account-federation",
358+
"sdk/headless-wallet/manage-sessions",
359+
"sdk/headless-wallet/on-ramp",
360+
"sdk/headless-wallet/fee-options",
361+
"sdk/headless-wallet/verification",
362+
"sdk/headless-wallet/transaction-receipts"
363+
]
364+
}
365+
]
366+
},
367+
{
368+
"group": "Go",
369+
"pages": [
370+
"sdk/go/overview"
371+
]
372+
},
373+
{
374+
"group": "Mobile",
375+
"pages": [
376+
"sdk/mobile"
377+
]
378+
}
379+
]
396380
}
397381
]
398382
},

‎sdk/headless-wallet/on-ramp.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ sidebarTitle: On-ramp
66
---
77

88

9-
Since the Embedded Wallet product can be integrated with [Sequence Kit](/sdk/web/overview) (a guide on this [here](/guides/custom-marketplace#7-optional-integrate-embedded-wallet-into-sequence-kit)), a developer can allow their users to purchase fiat via a credit or debit card with the use of a simplified react component.
9+
Since the Embedded Wallet product can be integrated with [Sequence Kit](/sdk/web/overview), a developer can allow their users to purchase fiat via a credit or debit card with the use of a simplified react component.
1010

1111
Integration steps can be found [here](/sdk/web/guides/on-ramp)

‎sdk/headless-wallet/quickstart.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Connect your users to your App with the Sequence Embedded Wallet.
55
sidebarTitle: Quickstart
66
---
77

8-
For Unreal or Unity integration, go to [Unreal](/sdk/unreal/quickstart) or [Unity](/sdk/unity/quickstart).
8+
For Unreal or Unity integration, go to [Unreal](/sdk/unreal/quickstart) or [Unity](/sdk/unity/installation).
99

1010
<Steps>
1111
<Step title="Clone Starter Repo">

‎sdk/overview.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: "Overview of the various SDKs available for integrating with the Se
66
Sequence provides multiple SDKs to help you integrate blockchain functionality into your applications across different platforms and languages.
77

88
<div className="not-prose grid gap-x-4 gap-y-4 sm:grid-cols-2 lg:grid-cols-3 mt-8">
9-
<a className="card block not-prose font-normal group relative my-2 ring-2 ring-transparent rounded-2xl bg-white dark:bg-background-dark border border-gray-950/10 dark:border-white/10 overflow-hidden w-full cursor-pointer hover:!border-primary dark:hover:!border-primary-light" href="/sdk/typescript/guides/overview">
9+
<a className="card block not-prose font-normal group relative my-2 ring-2 ring-transparent rounded-2xl bg-white dark:bg-background-dark border border-gray-950/10 dark:border-white/10 overflow-hidden w-full cursor-pointer hover:!border-primary dark:hover:!border-primary-light" href="/sdk/typescript/overview">
1010
<div className="px-6 py-5">
1111
<div className="h-6 w-6 fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100">
1212
<svg className="h-6 w-6 bg-primary dark:bg-primary-light" style={{maskImage: 'url("https://mintlify.b-cdn.net/v6.6.0/brands/js.svg")', maskRepeat: 'no-repeat', maskPosition: 'center center'}}></svg>
@@ -111,7 +111,7 @@ Choose the SDK that best matches your platform and development needs:
111111

112112
- For web applications:
113113
- Use [Web-SDK](/sdk/web/overview) for React applications
114-
- Use the [TypeScript/JavaScript SDK](/sdk/typescript/guides/overview) for core functionality
114+
- Use the [TypeScript/JavaScript SDK](/sdk/typescript/overview) for core functionality
115115

116116
For game development:
117117
- Use the [Unity SDK](/sdk/unity/overview) for Unity games

‎sdk/typescript/connectors/FAQ.mdx

-98
This file was deleted.

‎sdk/typescript/connectors/overview.mdx

-25
This file was deleted.

‎sdk/typescript/connectors/rainbow-kit.mdx

-100
This file was deleted.

0 commit comments

Comments
 (0)