Docs/lk exploration [SLT-170]

docs/bridge/docs/About/_category_.json

@@ -0,0 +1,4 @@
+{
+  "position": 0,
+  "label": "About"
+}

docs/bridge/docs/About/index.md

@@ -0,0 +1,64 @@
+# Use Synapse
+
+Synapse is an Interchain Programming Interface. Developers read and write interchain data with Synapse, which has settled $50B in transactions between 2M+ users, and generated $30M+ in fees [[source](https://explorer.synapseprotol.com)].
+
+## Why Synapse?
+
+_Description of top benefits Synapse brings to developers and users._
+
+
+## Get started
+
+* **[Send and receive interchain data](#)**
+* **[On-chain swaps](#)**
+* **[Interchain swaps](#)**
+* **[Upgrade to Synapse](#)**
+
+:::tip[Supported Chains]
+
+Synapse supports every chain and token that can be found on the [Synapse Bridge](https://synapseprotocol.com).
+
+:::
+
+## Interchain Bridge
+
+Embed the Synapse Widget or build your own custom instance.
+
+* **[Widget](#)** – Embed a customized Synapse Bridge in your application.
+* **[Client SDK](#)** – Call Synapse Router functions from your client application.
+* **[Server SDK](#)** – Call Synapse Router functions from your remote application.
+
+## Routers
+
+Synapse offers several of routers for different transaction types.
+
+* **[Synapse Router](#)** – Executable quotes for arbitrary blockchain transactions.
+* **[CCTP](#)** – Native router for USDC transactions.
+* **[RFQ](#)** – Fast router that allows on-chain agents to bid on interchain delivery.
+
+## Essential Tools
+
+Bolt-on services for reliability and ease-of-use:
+
+* **[Scribe](/docs/Services/Scribe)** – Index logs, receipts and transactions across multiple chains
+* **[Omnirpc](/docs/Services/Omnirpc)** – Interchain RPC load balancer and verifier
+* **[Key management](/docs/Services/Signer)** – Support for the AWS Key Management System (KMS)
+* **[Ethergo](/docs/Services/Submitter)** – Gas management service to ensure transaction confirmation
+* **[Telemetry](/docs/Services/Observability)** – Open telemetry system for Synapse SDK
+
+
+## Community & Support
+
+Connect with other developers and the Synapse team
+
+* **[Discord](https://discord.gg/synapseprotocol)**
+* **[Twitter](https://twitter.com/SynapseProtocol)**
+* **[Telegram](https://t.me/synapseprotocol)**
+* **[Forum](https://forum.synapseprotocol.com/)**
+
+## Additional Links
+
+Synapse transactions can be observed confirmed via the following methods:
+
+* **[Synapse Bridge](https://synapseprotocol.com)** – Bridge, Swap, and Stake via Synapse's cross-chain pools.
+* **[Synapse Explorer](https://explorer.synapseprotocol.com)** – Public explorer for Synapse Bridge transactions.

docs/bridge/docs/Bridge/01-Widget.md

@@ -0,0 +1,3 @@
+# Widget
+
+Lorem ipsum

docs/bridge/docs/Bridge/02-SDK.md

@@ -0,0 +1,3 @@
+# SDK
+
+Lorem ipsum

docs/bridge/docs/Bridge/_category_.json

@@ -0,0 +1,4 @@
+{
+  "position": 1,
+  "label": "Bridge"
+}

docs/bridge/docs/Bridge/index.md

@@ -0,0 +1,38 @@
+# Synapse Bridge
+
+The [Synapse Bridge](https://synapseprotocol.com) and [Solana Bridge](https://solana.synapseprotocol.com/) seamlessly swap on-chain assets between 20+ EVM and non-EVM blockchains in a safe and secure manner.
+
+## Developers
+
+Add the [Custom Widget](#) to your DeFi application, or build your own DeFi applications using the [Synapse SDK](#).
+
+## Bridge Functions
+
+The [Synapse Router](#) will return an appropriate bridge function based on the chains and tokens involved.
+
+* **Canonical** – Assets are wrapped and then bridged.
+* **[Liquidity Pools](#)** – Assets are swapped via Synapse liquidity pools.
+* **[CCTP](#)** – Native router for USDC
+
+## Pool Liquidity
+
+Synapse liquidity pools use the nexus USD (nUSD) and nexus ETH (nETH) interchain stablecoins. nUSD and nETH are fully backed by the nexus USD and nexus ETH liquidity pools on Ethereum.
+
+When a token is bridged using a Synapse Liquidity Pool, it is converted to a nexus token on the source chain, which is then bridged to the destination chain, before being converted back into a native token.
+
+## Using the Bridge
+
+To use the [Synapse Bridge](https://synapseprotocol.com):
+
+1. Connect your wallet
+2. Select your origin and destination chains from the dropdown menus
+3. Select your origin token from the portfolio view, or dropdown menu
+4. Enter the amount you wish to send
+5. If you wish to send assets to a different wallet address, enable `Show withdrawal address` from the Settings menu (optional).
+5. Connect your wallet to the origin chain, if necessary
+6. Click `Bridge` to send a quote to your wallet for confirmation
+7. Sign and Confirm the Bridge action from your wallet
+
+## Bridge Contracts
+
+Synapse Bridge contracts are available [here](https://docs.synapseprotocol.com/synapse-bridge/contract-addresses).

docs/bridge/docs/Developers/01-Messages.md

@@ -0,0 +1,3 @@
+# Interchain Data
+
+Lorem ipsum

docs/bridge/docs/Developers/02-On-chain.md

@@ -0,0 +1,3 @@
+# On-chain asset swaps
+
+Lorem ipsum

docs/bridge/docs/Developers/03-Interchain.md

@@ -0,0 +1,3 @@
+# Interchain asset swaps
+
+Lorem ipsum

docs/bridge/docs/Developers/04-Advanced-Projects.md

@@ -0,0 +1,3 @@
+# Advanced projects
+
+Lorem ipsum

docs/bridge/docs/Developers/05-Add-Synapse.md

@@ -0,0 +1,3 @@
+# Add Synapse to my app
+
+Lorem ipsum

docs/bridge/docs/Developers/index.md

@@ -0,0 +1,6 @@
+# Developer Guides
+
+* **[Send and receive interchain data](#)**
+* **[On-chain swaps](#)**
+* **[Interchain swaps](#)**
+* **[Upgrade to Synapse](#)**

docs/bridge/docs/Routers/01-Router-v2.md

@@ -0,0 +1,3 @@
+# Router v2
+
+Lorem ipsum

docs/bridge/docs/CCTP/Relayer.md → docs/bridge/docs/Routers/CCTP/Relayer.md

@@ -104,4 +104,4 @@ The CCTP Relayer is configured with a yaml file. The following is an example con
 
 ### Observability
 
-The CCTP relayer implements open telemetry for both tracing and metrics. Please see the [Observability](../Observability) page for more info. We'd also highly recommend setting up the [submitter dashboard](../Services/Submitter) as well.
+The CCTP relayer implements open telemetry for both tracing and metrics. Please see the [Observability](docs/Services/Observability) page for more info. We'd also highly recommend setting up the [submitter dashboard](../Services/Submitter) as well.

docs/bridge/docs/Routers/CCTP/_category_.json

@@ -0,0 +1,3 @@
+{
+  "label": "CCTP"
+}

docs/bridge/docs/CCTP/Overview.md → docs/bridge/docs/Routers/CCTP/index.md

@@ -1,3 +1,5 @@
+# Overview
+
 Synapse CCTP is a custom module built on top of Circle's [Cross-Chain Transfer Protocol](https://www.circle.com/en/cross-chain-transfer-protocol) that allows for bridge requests to natively mint & burn USDC on [supported chains](https://developers.circle.com/stablecoins/docs/cctp-getting-started#supported-blockchains).
 
 Synapse's CCTP implementation consists of two main components:

docs/bridge/docs/rfq/API/API.md → docs/bridge/docs/Routers/RFQ/API/API.md

@@ -72,7 +72,7 @@ Yaml settings:
  - `database` - The database settings for the API backend. A database is required to store quotes and other information. Using SQLite with a dsn set to a `/tmp/` directory is recommended for development.
    -  `type` - the database driver to use, can be `mysql` or `sqlite`.
    -  `dsn` - the dsn of your database. If using sqlite, this can be a path, if using mysql please see [here](https://dev.mysql.com/doc/connector-odbc/en/connector-odbc-configuration.html) for more information.
- - `omnirpc_url` - The omnirpc url to use for querying chain data (no trailing slash). For more information on omnirpc, see [here](../../Services/Omnirpc.md).
+ - `omnirpc_url` - The omnirpc url to use for querying chain data (no trailing slash). For more information on omnirpc, see [here](docs/Services/Omnirpc.md).
  - `bridges` - A key value map of chain id to FastBridge contract address. The API will only allow quotes to be posted on these chains.
  - `port` - The port to run the http server on.
 

docs/bridge/docs/rfq/Relayer/Relayer.md → docs/bridge/docs/Routers/RFQ/Relayer/Relayer.md

@@ -271,7 +271,7 @@ The relayer is configured with a yaml file. The following is an example configur
 
 ### Observability
 
-The RFQ relayer implements open telemetry for both tracing and metrics. Please see the [Observability](../../Observability) page for more info. There is also a custom [grafana dashboard](https://github.com/synapsecns/sanguine/tree/master/services/rfq/relayer/dashboards/dashboard.json) available for the relayer. We'd also highly recommend setting up the [submitter dashboard](../../Services/Submitter) as well.
+The RFQ relayer implements open telemetry for both tracing and metrics. Please see the [Observability](docs/Services/Observability) page for more info. There is also a custom [grafana dashboard](https://github.com/synapsecns/sanguine/tree/master/services/rfq/relayer/dashboards/dashboard.json) available for the relayer. We'd also highly recommend setting up the [submitter dashboard](../../Services/Submitter) as well.
 
 ![Relayer Grafana Dashboard](dashboard.png)
 

docs/bridge/docs/Routers/index.md

@@ -0,0 +1,7 @@
+# Synapse Routers
+
+Synapse offers several of routers for different transaction types.
+
+* **[Synapse Router](#)** – Executable quotes for arbitrary blockchain transactions.
+* **[CCTP](CCTP)** – Native router for USDC transactions.
+* **[RFQ](RFQ)** – Fast router that allows on-chain agents to bid on interchain delivery.

docs/bridge/docs/Services/Scribe.md

@@ -117,4 +117,4 @@ For a full list of available queries, refer to the GraphQL schema.
 
 ## Observability
 
-Scribe implements open telemetry for both tracing and metrics. Please see the [Observability](../Observability) page for more info.
+Scribe implements open telemetry for both tracing and metrics. Please see the [Observability](./Observability) page for more info.

docs/bridge/docs/Services/index.md

@@ -0,0 +1,9 @@
+# Essential Tools
+
+Synapse offers a number of bolt-on services for reliability and ease-of-use.
+
+* **[Scribe](/docs/Services/Scribe)** – Index logs, receipts and transactions across multiple chains
+* **[Omnirpc](/docs/Services/Omnirpc)** – Interchain RPC load balancer and verifier
+* **[Key management](/docs/Services/Signer)** – Support for the AWS Key Management System (KMS)
+* **[Ethergo](/docs/Services/Submitter)** – Gas management service to ensure transaction confirmation
+* **[Telemetry](/docs/Services/Observability)** – Open telemetry system for Synapse SDK

docs/bridge/docs/Support/index.md

@@ -0,0 +1,8 @@
+# Community & Support
+
+Connect with other developers and the Synapse team
+
+* **[Discord](https://discord.gg/synapseprotocol)**
+* **[Twitter](https://twitter.com/SynapseProtocol)**
+* **[Telegram](https://t.me/synapseprotocol)**
+* **[Forum](https://forum.synapseprotocol.com/)**

docs/bridge/docusaurus.config.ts

@@ -1,8 +1,10 @@
-import {themes as prismThemes} from 'prism-react-renderer';
-import type {Config} from '@docusaurus/types';
-import type * as Preset from '@docusaurus/preset-classic';
-import * as path from "path";
-import {codecovWebpackPlugin} from "@codecov/webpack-plugin";
+/* eslint-disable prefer-arrow/prefer-arrow-functions */
+import * as path from 'path'
+
+import { themes as prismThemes } from 'prism-react-renderer'
+import type { Config } from '@docusaurus/types'
+import type * as Preset from '@docusaurus/preset-classic'
+import { codecovWebpackPlugin } from '@codecov/webpack-plugin'
 
 const config: Config = {
   title: 'Synapse Bridge Docs',
@@ -42,7 +44,7 @@ const config: Config = {
           editUrl:
             'https://github.com/synapsecns/sanguine/tree/master/docs/bridge/',
           // docLayoutComponent: "@theme/DocPage",
-          docItemComponent: "@theme/ApiItem" // derived from docusaurus-theme-openapi-docs
+          docItemComponent: '@theme/ApiItem', // derived from docusaurus-theme-openapi-docs
         },
         theme: {
           customCss: './src/css/custom.css',
@@ -120,54 +122,60 @@ const config: Config = {
       darkTheme: prismThemes.dracula,
     },
   } satisfies Preset.ThemeConfig,
-  themes: ["docusaurus-theme-openapi-docs"], // export theme components
+  themes: ['docusaurus-theme-openapi-docs'], // export theme components
   plugins: [
     [
       'docusaurus-plugin-openapi-docs',
       {
-        id: "api", // plugin id
-        docsPluginId: "classic", // id of plugin-content-docs or preset for rendering docs
+        id: 'api', // plugin id
+        docsPluginId: 'classic', // id of plugin-content-docs or preset for rendering docs
         config: {
-          rfqapi: { // the <id> referenced when running CLI commands
-            specPath: "../../services/rfq/api/docs/swagger.yaml", // path to OpenAPI spec, URLs supported
-            baseUrl: "https://rfq-api.omnirpc.io/",
-            outputDir: "docs/rfq/API", // output directory for generated files
-            sidebarOptions: { // optional, instructs plugin to generate sidebar.js
-              groupPathsBy: "tag", // group sidebar items by operation "tag"
+          rfqapi: {
+            // the <id> referenced when running CLI commands
+            specPath: '../../services/rfq/api/docs/swagger.yaml', // path to OpenAPI spec, URLs supported
+            baseUrl: 'https://rfq-api.omnirpc.io/',
+            outputDir: 'docs/rfq/API', // output directory for generated files
+            sidebarOptions: {
+              // optional, instructs plugin to generate sidebar.js
+              groupPathsBy: 'tag', // group sidebar items by operation "tag"
             },
           },
-        }
+        },
       },
     ],
     // please see: https://github.com/facebook/docusaurus/issues/8091#issuecomment-1269112001 for an explanation.
-    () => ({
-      name: 'resolve-react',
-      configureWebpack() {
-        return {
-          resolve: {
-            alias: {
-              // assuming root node_modules is up from "./packages/<your-docusaurus>
-              react: path.resolve('../../node_modules/react'),
+    function () {
+      return {
+        name: 'resolve-react',
+        configureWebpack() {
+          return {
+            resolve: {
+              alias: {
+                // assuming root node_modules is up from "./packages/<your-docusaurus>
+                react: path.resolve('../../node_modules/react'),
+              },
             },
-          },
-        };
-      },
-    }),
-    () => ({
-      name: 'bundle-analyzer',
-      configureWebpack() {
-        return {
-          plugins: [
-            codecovWebpackPlugin({
-              enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined,
-              bundleName: "docs-bridge",
-              uploadToken: process.env.CODECOV_TOKEN,
-            }),
-          ]
-        };
+          }
+        },
       }
-    }),
+    },
+    function () {
+      return {
+        name: 'bundle-analyzer',
+        configureWebpack() {
+          return {
+            plugins: [
+              codecovWebpackPlugin({
+                enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined,
+                bundleName: 'docs-bridge',
+                uploadToken: process.env.CODECOV_TOKEN,
+              }),
+            ],
+          }
+        },
+      }
+    },
   ],
-};
+}
 
-export default config;
+export default config