Skip to content

Upgrade to docusaurus 3 #38

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Jan 12, 2024
Merged
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
8 changes: 4 additions & 4 deletions docs/developers/tools/event-simulator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ Events you can simulate include:
- Approving a Merchant profile and their submitted payment product
- Manually provision a card for Apple or Google Pay

:::info
:::info
The list of simulator events is not exhaustive, and Swan often adds events as new features are released.
Please go to **Dashboard** > **Developers** > **Event Simulator** for all possibilities.

If there is an event you'd like to simulate to test your integration, please send an email to support@swan.io.
If there is an event you'd like to simulate to test your integration, please send an email to support@swan.io.
:::

## Example {#example}
Expand All @@ -44,12 +44,12 @@ In Sandbox, you need to do it yourself.

1. On your Dashboard, go to **Developers** > **Event Simulator** > **SEPA Credit Transfers**.
1. In the **Receive an Incoming Transfer** tab, enter all required information.
- You can also add an internal reference and a label. If you don't add a label, your transaction history will show *Transfer from {Debtor name}*.
- You can also add an internal reference and a label. If you don't add a label, your transaction history will show _Transfer from \{Debtor name\}_.
1. Click **Simulate**.
1. Instantly, the status changes to the new status. If the simulation succeeded, you'll see the status `Success` and your transaction ID.

![Image of Dashboard Event Simulator example using SEPA Credit Transfers](../../images/developers/tools/simulator-example.png)

:::tip Success
After a successful simulation transfer, you can use these funds on API Explorer.
:::
:::
21 changes: 13 additions & 8 deletions docs/topics/onboarding/partials/_overview.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
<div>Your main action is to <b>create {props.accountType} onboarding link</b>.
The link leads your user to a <b>multi-step form</b> through which Swan collects essential information to open the account.
<br/><br/>
When creating an onboarding link for your users, you can <b>pre-fill most of the information</b> for them.
When your user goes through the form, they'll confirm that the information you entered is correct.
Users can also fill in this information themselves.
<br/><br/>
</div>
<div>
Your main action is to <b>create {props.accountType} onboarding link</b>. The
link leads your user to a <b>multi-step form</b> through which Swan collects
essential information to open the account.
<br />
<br />
When creating an onboarding link for your users, you can <b>
pre-fill most of the information
</b> for them. When your user goes through the form, they'll confirm that the information
you entered is correct. Users can also fill in this information themselves.
<br />
<br />
</div>
8 changes: 3 additions & 5 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
const lightCodeTheme = require("prism-react-renderer/themes/palenight");
const darkCodeTheme = require("prism-react-renderer/themes/oceanicNext");
const path = require("path");
const prism = require("prism-react-renderer");

/** @type {import('@docusaurus/types').DocusaurusConfig} */
module.exports = {
Expand Down Expand Up @@ -66,8 +64,8 @@ module.exports = {
// copyright: `Copyright © ${new Date().getFullYear()} Swan`,
// },
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
theme: prism.themes.palenight,
darkTheme: prism.themes.oceanicNext,
},
},
markdown: {
Expand Down
27 changes: 11 additions & 16 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
"name": "@swan-io/docs",
"version": "0.0.0",
"private": true,
"engines": {
"node": ">=18.0"
},
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
Expand All @@ -15,26 +18,18 @@
"graphql-update-schemas": "mkdir scripts/graphql/dist && node scripts/graphql/downloadSchema.mjs"
},
"dependencies": {
"@docusaurus/core": "2.4.3",
"@docusaurus/preset-classic": "2.4.3",
"@docusaurus/theme-mermaid": "2.4.3",
"@docusaurus/theme-search-algolia": "2.4.3",
"@graphiql/plugin-explorer": "0.1.14",
"@graphiql/toolkit": "0.9.1",
"@graphql-markdown/docusaurus": "1.21.3",
"@graphql-tools/graphql-file-loader": "7.5.17",
"@mdx-js/react": "1.6.22",
"@docusaurus/core": "3.1.0",
"@docusaurus/preset-classic": "3.1.0",
"@docusaurus/theme-mermaid": "3.1.0",
"@docusaurus/theme-search-algolia": "3.1.0",
"@mdx-js/react": "^3.0.0",
"@svgr/webpack": "5.5.0",
"clsx": "1.2.1",
"docusaurus-plugin-matomo": "0.0.8",
"file-loader": "6.2.0",
"graphiql": "2.4.7",
"graphql": "16.8.1",
"graphql-config": "5.0.3",
"node-fetch": "3.3.2",
"prism-react-renderer": "1.3.5",
"react": "17.0.2",
"react-dom": "17.0.2",
"prism-react-renderer": "^2.1.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"url-loader": "4.1.1"
},
"browserslist": {
Expand Down
28 changes: 0 additions & 28 deletions scripts/graphql/downloadSchema.mjs

This file was deleted.

52 changes: 0 additions & 52 deletions src/pages/explorer.js

This file was deleted.

Loading