Merge branch 'master' into remove-elastic

ava-labs · Aug 2, 2024 · 979a75a · 979a75a
2 parents dcbef76 + 7e8127d
commit 979a75a
Show file tree

Hide file tree

Showing 3 changed files with 122 additions and 120 deletions.
diff --git a/configs/remoteContent.js b/configs/remoteContent.js
@@ -99,11 +99,11 @@ const remoteContent = [
           return {
             filename: "deep-dive.md",
             content: `---
-  tags: [Avalanche Warp Messaging, AWM, Cross-Subnet Communication, Cross-Chain Communication]
-  description: Avalanche Warp Messaging (AWM) provides a primitive for cross-subnet communication on the Avalanche Network.
-  keywords: [ docs, documentation, avalanche, awm, cross-subnet communication, cross-chain, cross-chain communication ]
-  sidebar_label: Deep Dive
-  sidebar_position: 1
+tags: [Avalanche Warp Messaging, AWM, Cross-Subnet Communication, Cross-Chain Communication]
+description: Avalanche Warp Messaging (AWM) provides a primitive for cross-subnet communication on the Avalanche Network.
+keywords: [ docs, documentation, avalanche, awm, cross-subnet communication, cross-chain, cross-chain communication ]
+sidebar_label: Deep Dive
+sidebar_position: 1
 ---
 
 ${updatedContent}`,
@@ -138,11 +138,11 @@ ${updatedContent}`,
           return {
             filename: "relayer.md",
             content: `---
-      tags: [Avalanche Warp Messaging, Relayer]
-      description: Reference relayer implementation for cross-chain Avalanche Warp Message delivery.
-      keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
-      sidebar_label: Run a Relayer
-      sidebar_position: 3
+tags: [Avalanche Warp Messaging, Relayer]
+description: Reference relayer implementation for cross-chain Avalanche Warp Message delivery.
+keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
+sidebar_label: Run a Relayer
+sidebar_position: 3
 ---
 
 ${newContent}`,
@@ -158,15 +158,15 @@ ${newContent}`,
       // /docs/build/cross-chain/teleporter/overview.md
       name: "teleporter-overview",
       sourceBaseUrl:
-        "https://raw.githubusercontent.com/ava-labs/teleporter/main/contracts/src/teleporter/",
+        "https://raw.githubusercontent.com/ava-labs/teleporter/main/contracts/teleporter/",
       documents: ["README.md"],
       outDir: "docs/build/cross-chain/teleporter/",
       // change file name and add metadata correct links
       modifyContent(filename, content) {
         if (filename.includes("README")) {
           const updatedContent = replaceRelativeLinks(
             content,
-            "https://github.com/ava-labs/teleporter/blob/main/contracts/src/teleporter/"
+            "https://github.com/ava-labs/teleporter/blob/main/contracts/teleporter/"
           );
 
           const newContent = insertLinesAfterFirstLine(
@@ -177,11 +177,11 @@ ${newContent}`,
           return {
             filename: "overview.md",
             content: `---
-        tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
-        description: Teleporter is a messaging protocol built on top of Avalanche Warp Messaging that provides a developer-friendly interface for sending and receiving cross-chain messages from within the EVM.
-        keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
-        sidebar_label: Overview
-        sidebar_position: 1
+tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
+description: Teleporter is a messaging protocol built on top of Avalanche Warp Messaging that provides a developer-friendly interface for sending and receiving cross-chain messages from within the EVM.
+keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
+sidebar_label: Overview
+sidebar_position: 1
 ---
 
 ${newContent}`,
@@ -211,12 +211,12 @@ ${newContent}`,
           return {
             filename: "deep-dive.md",
             content: `---
-        tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
-        description: Teleporter is an EVM compatible cross-subnet communication protocol built on top of Avalanche Warp Messaging (AWM), and implemented as a Solidity smart contract. It provides a mechanism to asynchronously invoke smart contract functions on other EVM blockchains within Avalanche. Teleporter provides a handful of useful features on top of AWM, such as specifying relayer incentives for message delivery, replay protection, message delivery and execution retries, and a standard interface for sending and receiving messages within a dApp deployed across multiple subnets.
-        keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
-        sidebar_label: Deep Dive
-        sidebar_position: 2
-        title: Teleporter Deep Dive
+tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
+description: Teleporter is an EVM compatible cross-subnet communication protocol built on top of Avalanche Warp Messaging (AWM), and implemented as a Solidity smart contract. It provides a mechanism to asynchronously invoke smart contract functions on other EVM blockchains within Avalanche. Teleporter provides a handful of useful features on top of AWM, such as specifying relayer incentives for message delivery, replay protection, message delivery and execution retries, and a standard interface for sending and receiving messages within a dApp deployed across multiple subnets.
+keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
+sidebar_label: Deep Dive
+sidebar_position: 2
+title: Teleporter Deep Dive
 ---
 
 ${updatedContent}`,
@@ -251,11 +251,11 @@ ${updatedContent}`,
           return {
             filename: "cli.md",
             content: `---
-        tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
-        description: This page the source code for the Avalanche Teleporter CLI. The CLI is a command line interface for interacting with the Teleporter contracts. It is written with [cobra](https://github.com/spf13/cobra) commands as a Go application.
-        keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication, teleporter cli ]
-        sidebar_label: CLI
-        sidebar_position: 6
+tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
+description: This page the source code for the Avalanche Teleporter CLI. The CLI is a command line interface for interacting with the Teleporter contracts. It is written with [cobra](https://github.com/spf13/cobra) commands as a Go application.
+keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication, teleporter cli ]
+sidebar_label: CLI
+sidebar_position: 6
 ---
 
 ${newContent}`,
@@ -271,15 +271,15 @@ ${newContent}`,
       // /docs/build/cross-chain/teleporter/upgradeability.md
       name: "teleporter-upgradeability",
       sourceBaseUrl:
-        "https://raw.githubusercontent.com/ava-labs/teleporter/main/contracts/src/teleporter/registry/",
+        "https://raw.githubusercontent.com/ava-labs/teleporter/main/contracts/teleporter/registry/",
       documents: ["README.md"],
       outDir: "docs/build/cross-chain/teleporter/",
       // change file name and add metadata correct links
       modifyContent(filename, content) {
         if (filename.includes("README")) {
           const updatedContent = replaceRelativeLinks(
             content,
-            "https://github.com/ava-labs/teleporter/blob/main/contracts/src/teleporter/registry/"
+            "https://github.com/ava-labs/teleporter/blob/main/contracts/teleporter/registry/"
           );
 
           const newContent = insertLinesAfterFirstLine(
@@ -290,11 +290,11 @@ ${newContent}`,
           return {
             filename: "upgradeability.md",
             content: `---
-            tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
-            description: Teleporter is an EVM-compatible cross-subnet communication protocol built on top of Avalanche Warp Messaging. The TeleporterMessenger contract is non-upgradable, once a version of the contract is deployed it cannot be changed. However, there could still be new versions of TeleporterMessenger contracts needed to be deployed in the future.
-            keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
-            sidebar_label: Upgradeability
-            sidebar_position: 5
+tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
+description: Teleporter is an EVM-compatible cross-subnet communication protocol built on top of Avalanche Warp Messaging. The TeleporterMessenger contract is non-upgradable, once a version of the contract is deployed it cannot be changed. However, there could still be new versions of TeleporterMessenger contracts needed to be deployed in the future.
+keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
+sidebar_label: Upgradeability
+sidebar_position: 5
 ---
 
 ${newContent}`,
@@ -323,11 +323,11 @@ ${newContent}`,
           return {
             filename: "evm-integration.md",
             content: `---
-    tags: [Avalanche Warp Messaging, Coreth, Subnet-EVM, Cross-Subnet Communication, Cross-Chain Communication]
-    description: Avalanche Warp Messaging provides a basic primitive for signing and verifying messages between Subnets. The receiving network can verify whether an aggregation of signatures from a set of source Subnet validators represents a threshold of stake large enough for the receiving network to process the message. The Avalanche Warp Precompile enables this flow to send a message from blockchain A to blockchain B.
-    keywords: [ coreth, subnet-evm, docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
-    sidebar_label: EVM Integration
-    sidebar_position: 2
+tags: [Avalanche Warp Messaging, Coreth, Subnet-EVM, Cross-Subnet Communication, Cross-Chain Communication]
+description: Avalanche Warp Messaging provides a basic primitive for signing and verifying messages between Subnets. The receiving network can verify whether an aggregation of signatures from a set of source Subnet validators represents a threshold of stake large enough for the receiving network to process the message. The Avalanche Warp Precompile enables this flow to send a message from blockchain A to blockchain B.
+keywords: [ coreth, subnet-evm, docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
+sidebar_label: EVM Integration
+sidebar_position: 2
 ---
 
 ${updatedContent}`,