Merge pull request #100 from ripple/portal-upgrade

Portal upgrade
ripple · Oct 9, 2024 · 300639c · 300639c
2 parents e1c4398 + 90db7f0
commit 300639c
Show file tree

Hide file tree

Showing 97 changed files with 5,712 additions and 54,857 deletions.
diff --git a/@theme/styles.css b/@theme/styles.css
diff --git a/_MIGRATION.md b/_MIGRATION.md
@@ -0,0 +1,35 @@
+# Manual migration instructions
+
+
+## MDX files
+
+Please, review and migrate MDX files manually:
+
+- `index.mdx`
+
+## RBAC
+
+Please, review RBAC changes as the RBAC configuration format has changed completely: https://redocly.com/docs/realm/setup/concepts/rbac
+
+
+## Theme
+
+Migrate theme settings manually: https://redocly.com/docs/realm/get-started/migrate-from-legacy-portal#migrate-theme
+
+Remove the `theme.ts` file after migration.
+
+## Adjust config
+
+- Consider removing the following from your redocly.yaml if you are able to solve all Markdoc and link issues:
+  ```yaml
+  reunite:
+    ignoreMarkdocErrors: true
+    ignoreLinkChecker: true
+  ```
+
+- In addition, if you want your website to be public, remove the `requiresLogin: true` from `redocly.yaml`.
+
+
+## After migration
+
+Remove this `_MIGRATION.md` file after migration.
diff --git a/components/LandingComponents.tsx b/components/LandingComponents.tsx
@@ -1,5 +1,5 @@
 import styled from "styled-components";
-import { H1, H2 } from "@redocly/developer-portal/ui";
+import { H1, H2 } from "@redocly/theme";
 
 const Header1 = styled(H1)`
   color: white !important;

diff --git a/components/TileText.tsx b/components/TileText.tsx
@@ -1,5 +1,5 @@
 import styled from "styled-components";
-import { Typography } from "@redocly/developer-portal/ui";
+import { Typography } from "@redocly/theme";
 import { theme } from "../theme";
 
 const TileText = styled(Typography)`

diff --git a/docs/axelar/bridge-tokens-axelar.md b/docs/axelar/bridge-tokens-axelar.md
@@ -1,6 +1,6 @@
 # Bridge Tokens Between Ethereum and XRPL
 
-<embed src="/snippets/_axelar-disclaimer.md" />
+{% partial file="/snippets/_axelar-disclaimer.md" /%}
 
 This tutorial describes how to transfer tokens between Ethereum `Sepolia` and the XRPL `Testnet`.
 

diff --git a/docs/axelar/call-a-smart-contract-function.md b/docs/axelar/call-a-smart-contract-function.md
@@ -1,6 +1,6 @@
 # Call a Smart Contract Function
 
-<embed src="/snippets/_axelar-disclaimer.md" />
+{% partial file="/snippets/_axelar-disclaimer.md" /%}
 
 This tutorial describes how to call a function from a smart contract on Ethereum `Sepolia` from the XRPL `Testnet`, using General Message Passing (GMP). The following diagram illustrates the process from a high level:
 

diff --git a/docs/clawback/clawback-of-issued-currency.md b/docs/clawback/clawback-of-issued-currency.md
@@ -7,7 +7,7 @@ labels:
 status: not_enabled
 ---
 # Clawback
-<embed src="/snippets/_clawback-disclaimer.md" />
+{% partial file="/snippets/_clawback-disclaimer.md" /%}
 For regulatory purposes, some issuers must have the ability to recover issued tokens after they are distributed to accounts. For example, if an issuer were to discover that tokens were sent to an account sanctioned for illegal activity, the issuer could recover, or *claw back*, the funds.
 
 Issuers can create tokens that they can claw back by adding the `lsfAllowTrustLineClawback` flag to the issuing account.

diff --git a/docs/clawback/clawback.md b/docs/clawback/clawback.md
@@ -10,7 +10,7 @@ status: not_enabled
 
 [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/tx/impl/Clawback.cpp "Source")
 
-<embed src="/snippets/_clawback-disclaimer.md" />
+{% partial file="/snippets/_clawback-disclaimer.md" /%}
 
 Claw back an issued currency transfer between accounts in a trust set.
 

diff --git a/docs/evm-sidechain/bootstrap-a-local-environment.md b/docs/evm-sidechain/bootstrap-a-local-environment.md
@@ -8,7 +8,7 @@ status: not_enabled
 ---
 # Bootstrap a Local Environment
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 The `boostrap` command enables you to create a local development environment. This environment consists of:
 

diff --git a/docs/evm-sidechain/bridge-client.md b/docs/evm-sidechain/bridge-client.md
@@ -7,7 +7,7 @@ status: not_enabled
 ---
 # Bridge Client
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 The bridge client provides a user interface to interact with your bridge. You can use the client to connect wallets and transfer XRP or tokens across XRPL chains.
 

diff --git a/docs/evm-sidechain/bridge-door-interface.md b/docs/evm-sidechain/bridge-door-interface.md
@@ -7,7 +7,7 @@ status: not_enabled
 ---
 # Bridge Door Interface
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 ## Events
 

diff --git a/docs/evm-sidechain/bridge-door-safety-mechanisms.md b/docs/evm-sidechain/bridge-door-safety-mechanisms.md
@@ -7,7 +7,7 @@ status: not_enabled
 ---
 # Bridge Door Safety Mechanisms
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 This page describes the options you have to mitigate any risks that may occur during the life of a bridge. None of these mechanisms can be activated by a single witness; only transactions executed from the Gnosis Safe can activate them.
 

diff --git a/docs/evm-sidechain/bridge-doors.md b/docs/evm-sidechain/bridge-doors.md
@@ -7,7 +7,7 @@ status: not_enabled
 ---
 # Bridge Doors
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 Bridge doors on the XRPL EVM sidechain are _Solidity_ smart contracts that have the logic to execute all transactions introduced by XLS-38d.
 

diff --git a/docs/evm-sidechain/bridges-intro.md b/docs/evm-sidechain/bridges-intro.md
@@ -7,7 +7,7 @@ status: not_enabled
 ---
 # Bridges
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 Bridges are mechanisms that connect two blockchains together, enabling interoperability between the two. This connection enables users to transfer data or digital assets across separate blockchains that may have different protocols, consensus mechanisms, and other underlying technologies.
 

diff --git a/docs/evm-sidechain/build-and-run-witness-servers.md b/docs/evm-sidechain/build-and-run-witness-servers.md
@@ -7,7 +7,7 @@ status: not_enabled
 ---
 # Build and Run Witness Servers
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 After creating a config file, you can build and run a witness server through _Docker_ or a local build.
 

diff --git a/docs/evm-sidechain/configure-the-bridge-client.md b/docs/evm-sidechain/configure-the-bridge-client.md
@@ -7,7 +7,7 @@ status: not_enabled
 ---
 # Configure the Bridge Client
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 The client requires separate configuration files for the backend frontend. Each environment setting also requires its own configuration files.
 

diff --git a/docs/evm-sidechain/connect-metamask-to-xrpl-evm-sidechain.md b/docs/evm-sidechain/connect-metamask-to-xrpl-evm-sidechain.md
@@ -8,7 +8,7 @@ status: not_enabled
 ---
 # Connect MetaMask to the XRPL EVM Sidechain
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 MetaMask is an extension for accessing Harmony-enabled distributed applications (_dapps_) from your browser. The extension injects the XRP Ledger EVM sidechain Web3 API into every website's Javascript context, so that Web3 applications can read from the blockchain. <!-- SPELLING_IGNORE: dapps -->
 

diff --git a/docs/evm-sidechain/create-a-bridge.md b/docs/evm-sidechain/create-a-bridge.md
@@ -8,7 +8,7 @@ status: not_enabled
 ---
 # Create a Bridge
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 The `bridge create` command enables you to set up a bridge.
 

diff --git a/docs/evm-sidechain/deploy-a-bridge.md b/docs/evm-sidechain/deploy-a-bridge.md
@@ -7,7 +7,7 @@ status: not_enabled
 ---
 # Deploy a Bridge
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 Before deploying a bridge, familiarize yourself with the parameters and terms used:
 

diff --git a/docs/evm-sidechain/evm-cli.md b/docs/evm-sidechain/evm-cli.md
@@ -8,7 +8,7 @@ status: not_enabled
 ---
 # XRPL EVM CLI
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 The command line tool for the XRPL EVM sidechain enables developers and operators to set up networks, create bridges, execute transactions, and more.
 

diff --git a/docs/evm-sidechain/evm-sidechain-validator-security.md b/docs/evm-sidechain/evm-sidechain-validator-security.md
@@ -8,7 +8,7 @@ status: not_enabled
 ---
 # XRPL EVM Sidechain Validator Security
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 Each validator candidate is encouraged to run its operations independently, as diverse setups increase the resilience of the network. Validator candidates should begin their setup phase now, to be on time for launch.
 

diff --git a/docs/evm-sidechain/execute-bridge-operations.md b/docs/evm-sidechain/execute-bridge-operations.md
@@ -8,7 +8,7 @@ status: not_enabled
 ---
 # Execute Bridge Operations
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 This tutorial walks you through the process of creating a bridge account and transfering funds from the issuing chain to the locking chain.
 

diff --git a/docs/evm-sidechain/get-started-evm-sidechain.md b/docs/evm-sidechain/get-started-evm-sidechain.md
@@ -8,7 +8,7 @@ status: not_enabled
 ---
 # Get Started with the XRPL EVM Sidechain
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 This getting started tutorial walks you through the steps to set up your account and submit a transaction using the EVM sidechain bridge. 
 

diff --git a/docs/evm-sidechain/intro-to-evm-sidechain.md b/docs/evm-sidechain/intro-to-evm-sidechain.md
@@ -8,7 +8,7 @@ status: not_enabled
 ---
 # Introduction to XRPL EVM Sidechain
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 The XRP Ledger Ethereum Virtual Machine (EVM) sidechain is a fast and secure blockchain that brings web3 applications to the XRP Ledger community.
 

diff --git a/docs/evm-sidechain/join-evm-sidechain-devnet.md b/docs/evm-sidechain/join-evm-sidechain-devnet.md
@@ -8,7 +8,7 @@ status: not_enabled
 ---
 # Join the XRPL EVM Sidechain Devnet
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 This tutorial walks you through the steps to join the existing **XRP Ledger EVM Sidechain Devnet**. 
 
@@ -76,11 +76,11 @@ All these commands create your `~/.exrpd` (i.e `$HOME`) directory with subfol
     wget https://raw.githubusercontent.com/Peersyst/xrp-evm-archive/main/poa-devnet/genesis.json -O ~/.exrpd/config/genesis.json
     ```
 
-   :::attention Attention
+   {% admonition type="info" name="Attention" %}
 
    Before jumping to the next item, make sure that the contents of the file `~/.exrpd/config/genesis.json` match the contents of the file [genesis.json](https://raw.githubusercontent.com/Peersyst/xrp-evm-archive/main/poa-devnet/genesis.json).
-
-   :::
+   
+   {% /admonition %}
 
     Verify the genesis configuration file:
 

diff --git a/docs/evm-sidechain/manage-the-validator-node.md b/docs/evm-sidechain/manage-the-validator-node.md
@@ -8,7 +8,7 @@ status: not_enabled
 ---
 # Manage the Validator Node
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 
 ## Edit Validator Description

diff --git a/docs/evm-sidechain/set-up-an-evm-sidechain.md b/docs/evm-sidechain/set-up-an-evm-sidechain.md
@@ -8,7 +8,7 @@ status: not_enabled
 ---
 # Set Up an EVM Sidechain
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 You can set up an EVM sidechain using the `blockchain create` command.
 

diff --git a/docs/evm-sidechain/start-the-bridge-client.md b/docs/evm-sidechain/start-the-bridge-client.md
@@ -7,7 +7,7 @@ status: not_enabled
 ---
 # Start the Bridge Client
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 ## Prerequisites
 

diff --git a/docs/evm-sidechain/stress-test-the-bridge.md b/docs/evm-sidechain/stress-test-the-bridge.md
@@ -8,7 +8,7 @@ status: not_enabled
 ---
 # Stress Test the Bridge
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 You can stress test account creations and claims.
 

diff --git a/docs/evm-sidechain/stress-test-the-evm-sidechain.md b/docs/evm-sidechain/stress-test-the-evm-sidechain.md
@@ -8,7 +8,7 @@ status: not_enabled
 ---
 # Stress Test the EVM CLI
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 You can stress test the blockchain using the `blockchain stress` command.
 

diff --git a/docs/evm-sidechain/witness-server-configuration.md b/docs/evm-sidechain/witness-server-configuration.md
@@ -7,7 +7,7 @@ status: not_enabled
 ---
 # Witness Server Configuration
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 Before running a witness server, you must create a YAML configuration file. Some fields can be configured through environment variables; in the case of conficts, the environment variable is used instead of the YAML key.
 

diff --git a/docs/evm-sidechain/witness-servers.md b/docs/evm-sidechain/witness-servers.md
@@ -7,7 +7,7 @@ status: not_enabled
 ---
 # Witness Servers
 
-<embed src="/snippets/_evm-sidechain-disclaimer.md" />
+{% partial file="/snippets/_evm-sidechain-disclaimer.md" /%}
 
 A witness server enables bridge operators to listen for transactions on the connected chains and sign attestations. _Attestations_ are used as proof that events on a chain occurred.
 

diff --git a/docs/index.page.tsx b/docs/index.page.tsx
diff --git a/docs/xls-30d-amm/ledger-object-types/amm.md b/docs/xls-30d-amm/ledger-object-types/amm.md
@@ -10,7 +10,7 @@ status: not_enabled
 [[Source]](https://github.com/gregtatcam/rippled/blob/c1e4bfb08bcc9f187d794a71d653003a6148dc68/src/ripple/protocol/impl/LedgerFormats.cpp#L265-L275 "Source")
 <!-- TODO: Update source link to merged version when available -->
 
-<embed src="/snippets/_amm-disclaimer.md" />
+{% partial file="/snippets/_amm-disclaimer.md" /%}
 
 
 The `AMM` object type describes a single [Automated Market Maker](../automated-market-makers.md) (AMM) instance.

diff --git a/docs/xls-30d-amm/public-api-methods/amm_info.md b/docs/xls-30d-amm/public-api-methods/amm_info.md
@@ -12,16 +12,16 @@ labels:
 
 The `amm_info` method gets information about an Automated Market Maker (AMM) instance.
 
-<embed src="/snippets/_amm-disclaimer.md" />
+{% partial file="/snippets/_amm-disclaimer.md" /%}
 
 
 ### Request Format
 
 An example of the request format:
 
-:::info Note
+{% admonition type="info" name="Note" %}
 There is no commandline syntax for this method. You can use the [json method](https://xrpl.org/json.html) to access this method from the commandline instead.
-:::
+{% /admonition %}
 
 <!-- MULTICODE_BLOCK_START -->
 

diff --git a/docs/xls-30d-amm/public-api-methods/ledger_entry.md b/docs/xls-30d-amm/public-api-methods/ledger_entry.md
@@ -13,7 +13,7 @@ Retrieve an Automated Market-Maker (AMM) object from the ledger. This is similar
 | `amm.asset2` | Object           | The other of the two assets in this AMM's pool, as a [currency object without an amount](https://xrpl.org/currency-formats.htcurrency-formats.html#specifying-without-amounts). |
 
 
-```json WebSocket
+```json {% title="WebSocket" %}
 {
   "id": 30,
   "command": "ledger_entry",
@@ -30,7 +30,7 @@ Retrieve an Automated Market-Maker (AMM) object from the ledger. This is similar
 }
 ```
 
-```json JSON-RPC
+```json {% title="JSON-RPC" %}
 {
     "method": "ledger_entry",
     "params": [
@@ -50,7 +50,7 @@ Retrieve an Automated Market-Maker (AMM) object from the ledger. This is similar
 }
 ```
 
-```sh Commandline
+```sh {% title="Commandline" %}
 rippled json ledger_entry '{ "amm": { "asset": { "currency": "XRP" }, "asset2": { "currency" : "TST", "issuer" : "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd" } }, "ledger_index": "validated" }'
 ```
 
diff --git a/docs/xls-30d-amm/transaction-types/ammbid.md b/docs/xls-30d-amm/transaction-types/ammbid.md
@@ -9,7 +9,7 @@ status: not_enabled
 # AMMBid
 [[Source]](https://github.com/XRPLF/rippled/blob/develop/src/ripple/app/tx/impl/AMMBid.cpp "Source")
 
-<embed src="/snippets/_amm-disclaimer.md" />
+{% partial file="/snippets/_amm-disclaimer.md" /%}
 
 Bid on an [Automated Market Maker](../automated-market-makers.md)'s (AMM's) auction slot. If you win, you can trade against the AMM at a discounted fee until you are outbid or 24 hours have passed. If you are outbid before 24 hours have passed, you are refunded part of the cost of your bid based on how much time remains.
 

diff --git a/docs/xls-30d-amm/transaction-types/ammcreate.md b/docs/xls-30d-amm/transaction-types/ammcreate.md
@@ -9,7 +9,7 @@ status: not_enabled
 # AMMCreate
 [[Source]](https://github.com/XRPLF/rippled/blob/develop/src/ripple/app/tx/impl/AMMCreate.cpp "Source")
 
-<embed src="/snippets/_amm-disclaimer.md" />
+{% partial file="/snippets/_amm-disclaimer.md" /%}
 
 Create a new [Automated Market Maker](../automated-market-makers.md) (AMM) instance for trading a pair of assets ([fungible tokens](https://xrpl.org/tokens.html) or [XRP](https://xrpl.org/xrp.html)).