Feat/portal bridge docs migration (#196)

* setup docs site * update nav bar * remove unecesary assets * add token register section and fix build issue * fix prettier * set base url to PUBLIC_URL env * update FAQ links * add production deployment and minor change * fix wrong tags * remove content * fix saber.so links * remove unecesary files * update sui site faqs link * [skip ci] bump version
XLabs · Jun 22, 2023 · e7d5aac · e7d5aac
1 parent b23ca69
commit e7d5aac
Show file tree

Hide file tree

Showing 88 changed files with 14,614 additions and 9 deletions.
diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml
@@ -38,6 +38,36 @@ jobs:
         with:
           name: preview-stable-bridge-build
           path: out
+  docs:
+    name: "Build Portal Bridge Documentation"
+    runs-on: "ubuntu-latest"
+    concurrency:
+      group: ${{ github.ref }}-portal-docs-preview
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Set up Node environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: v16.19.1
+      - name: Install dependencies
+        run: |
+          pushd docs
+          npm ci
+      - name: Set Version
+        run: |
+          echo "_BRANCH_NAME_SHA=$(echo ${{ github.event.pull_request.head.ref }} | sha256sum | cut -c -10)" >> "${GITHUB_ENV}"
+      - name: Build
+        env:
+          PUBLIC_URL: "/${{ env._BRANCH_NAME_SHA }}/docs"
+        run: |
+          pushd docs
+          npm run build
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs-preview-build
+          path: docs/build
 
   portal:
     name: "Build Portal Bridge"
@@ -98,6 +128,7 @@ jobs:
     name: "Publish"
     needs: 
       - portal
+      - docs
       - cctp
     runs-on: "ubuntu-latest"
     concurrency:
@@ -111,6 +142,11 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: preview-build
+      - name: Download Artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: docs-preview-build
+          path: docs
       - name: Download Artifact
         uses: actions/download-artifact@v3
         with:

diff --git a/.github/workflows/production.yml b/.github/workflows/production.yml
@@ -38,6 +38,35 @@ jobs:
           name: release-stable-bridge
           path: out
 
+  docs:
+    name: "Build Portal Bridge Documentation"
+    runs-on: "ubuntu-latest"
+    concurrency:
+      group: ${{ github.ref }}-portal-docs-preview
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Set up Node environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: v16.19.1
+      - name: Install dependencies
+        run: |
+          pushd docs
+          npm ci
+      - name: Set Version
+        run: |
+          echo "_BRANCH_NAME_SHA=$(echo ${{ github.event.pull_request.head.ref }} | sha256sum | cut -c -10)" >> "${GITHUB_ENV}"
+      - name: Build
+        run: |
+          pushd docs
+          npm run build
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs-release-build
+          path: docs/build
+
   portal:
     name: "Build Portal Bridge"
     runs-on: ubuntu-latest
@@ -97,6 +126,7 @@ jobs:
     needs:
       - portal
       - cctp
+      - docs
     runs-on: "ubuntu-latest"
     concurrency:
       group: ${{ github.ref }}-publish-release
@@ -109,6 +139,11 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: release-portal-bridge
+      - name: Download Artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: docs-release-build
+          path: docs
       - name: Download Artifact
         uses: actions/download-artifact@v3
         with:

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/docs/babel.config.js b/docs/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/docs/docs/faqs/common-error-messages.md b/docs/docs/faqs/common-error-messages.md
@@ -0,0 +1,38 @@
+---
+sidebar_position: 3
+title: Common error messages
+---
+
+# Common error messages
+
+### **Error message: "Cannot read properties of undefined (reading 'replace')"**
+
+This error means that the incorrect transaction was input into the redeem source tx field. You can find the correct one by searching your wallet address in the corresponding blockchain explorer and selecting the correct transaction. &#x20;
+
+### Error message: "Unknown error"&#x20;
+
+* Please ensure you have at least 0.01 SOL in your Solana wallet
+* If you're using a ledger, ensure the software is up to date and ensure blind signing is turned on.&#x20;
+
+### Error message: "**Transaction was not confirmed in 30.04 seconds. It is unknown if it succeeded or failed. Check signature xyz using the Solana Explorer or CLI tools."**
+
+That indicates a temporary Solana network error. Please try again in a few hours, when TPS is above 2000: [https://explorer.solana.com/](https://explorer.solana.com/) (you need to scroll down a bit). With your origin source transaction id, you can redeem at any time here: [https://www.portalbridge.com/#/redeem](https://www.portalbridge.com/#/redeem)&#x20;
+
+### Error message: "failed to send transaction: Transaction simulation failed: Error processing Instruction 0: custom program error: 0x0"
+
+(Solana only)&#x20;
+
+* Please ensure you have 0.01 Sol in your wallet
+* You'll need to create an associated token account.&#x20;
+  * Please open a new tab and do the redeem steps again: [https://portalbridge.com/#/redeem](https://portalbridge.com/#/redeem)&#x20;
+  * You just need to enter your source chain and the corresponding transaction id (which you can find in your wallet, or with your address in the blockchains explorer)&#x20;
+  * After completing, you can hover over the recipient’s address and click "force create account".
+  * Click "redeem"
+
+### Error message: "failed to get confirmed transaction: Invalid param: Invalid"
+
+This error means the incorrect **source chain** was selected during the redeem process. Please double check the correct source chain was selected.&#x20;
+
+### Error message: "**404 insufficient funds or unknown error, key not found, account not found / rpc error: code = NotFound desc = rpc error: code = NotFound desc = account not found: key not found"**
+
+(Terra only) This means that you have insufficient funds in your wallet. Please make sure you have sufficient LUNA in your wallet to pay for network fees.&#x20;
diff --git a/docs/docs/faqs/index.md b/docs/docs/faqs/index.md
@@ -0,0 +1,47 @@
+---
+sidebar_position: 1
+title: FAQs
+description: >-
+  This page collects and answers the most commonly asked questions.
+slug: /
+---
+
+# FAQs
+
+> :interrobang: Developing on Wormhole? Check out [the book](https://book.wormhole.com)! :book:
+
+## General FAQ
+
+### How does the Portal work?
+
+The Portal is an application built on top of Wormhole. When you bridge tokens through Portal, the origin token gets locked in a smart contract, and a new Portal wrapped token gets minted on the target chain. You can swap those for other/native tokens on the target chain. See which Portal wrapped tokens have liquid markets [here.](./liquid-markets.mdx)
+
+Here you can find an in-depth explanation from one of our contributors, Chase:
+
+<iframe width="100%" height="315" src="https://www.youtube.com/embed/ngnWF5widJU" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
+
+### What are the liquid markets for Portal wrapped tokens?
+
+Check out our liquid markets [here.](./liquid-markets.mdx)
+
+### What does the token register do?
+
+The token register is to register new tokens on a chain, this is a once-off procedure.  There will be a small fee charged to register the token. This is most commonly used by projects who will transfer the token over for the first time. Normal users will rarely ever have to use this function.&#x20;
+
+### What type of NFTs does Portal NFT bridge support?&#x20;
+
+The Portal NFT bridge allows ERC721 and SPL (with a supply of 1) NFTs to be transferred between supported chains.&#x20;
+
+### What are the fees for using Portal?
+
+Portal bridging fees are currently sub-cent. The gas fees are the most expensive aspect of the transaction.&#x20;
+
+## 📞 Contact
+
+If you have any further questions or require troubleshooting, please reach out to Wormhole's community managers on [Discord](https://discord.com/invite/wormholecrypto).&#x20;
+
+:::danger
+
+Beware of scams. Admins will never DM or message you first
+
+:::