feat(docs): add mermaid support to docs (#1929)

* Add mermaid support * Remove hoist command --------- Co-authored-by: Chen Hui Jing <[email protected]>
interledger · Sep 22, 2023 · 6a2ae15 · 6a2ae15
1 parent 006e7a9
commit 6a2ae15
Show file tree

Hide file tree

Showing 6 changed files with 527 additions and 2 deletions.
diff --git a/packages/documentation/astro.config.mjs b/packages/documentation/astro.config.mjs
@@ -6,14 +6,15 @@ import react from '@astrojs/react'
 
 import remarkMath from 'remark-math'
 import rehypeMathjax from 'rehype-mathjax'
+import remarkMermaid from 'remark-mermaidjs'
 import GraphQL from 'astro-graphql-plugin'
 
 // https://astro.build/config
 export default defineConfig({
   site: 'https://rafiki.dev',
   outDir: './build',
   markdown: {
-    remarkPlugins: [remarkMath],
+    remarkPlugins: [remarkMath, remarkMermaid],
     rehypePlugins: [rehypeMathjax]
   },
   integrations: [

diff --git a/packages/documentation/netlify.toml b/packages/documentation/netlify.toml
@@ -0,0 +1,17 @@
+# Settings in the [build] context are global and are applied to
+# all contexts unless otherwise overridden by more specific contexts.
+[build]
+  # Directory where the build system installs dependencies
+  # and runs your build. Store your package.json, .nvmrc, etc here.
+  # If not set, defaults to the root directory.
+  base = "packages/documentation"
+
+  # Directory that contains the deploy-ready HTML files and
+  # assets generated by the build. This is an absolute path relative 
+  # to the base directory, which is the root by default (/).
+  # This sample publishes the directory located at the absolute 
+  # path "root/project/build-output"
+  publish = "build/"
+
+  # Default build command.
+  command = "pnpm install --no-frozen-lockfile && pnpm dlx playwright install chromium && pnpm build"
diff --git a/packages/documentation/package.json b/packages/documentation/package.json
@@ -21,6 +21,7 @@
     "react-dom": "^18.2.0",
     "rehype-mathjax": "^4.0.3",
     "remark-math": "^5.1.1",
+    "remark-mermaidjs": "^5.0.2",
     "sharp": "^0.32.6"
   }
 }
diff --git a/packages/documentation/src/content/docs/integration/event-handlers.md b/packages/documentation/src/content/docs/integration/event-handlers.md
@@ -9,6 +9,7 @@ Rafiki communicates with the Account Servicing Entity over webhook events, as me
 The `incoming_payment.created` event indicates that an incoming payment has been created. It has not yet received any funds so no action is required. The webhook event is informational and allows the Account Servicing Entity to display upcoming incoming payments to their users.
 
 ```mermaid
+
 sequenceDiagram
 
 participant ASE as Account Servicing Entity
@@ -25,6 +26,7 @@ The `incoming_payment.completed` event indicates that an incoming payment has be
 Example: An incoming payment was completed and received $10.
 
 ```mermaid
+
 sequenceDiagram
 
 participant ASE as Account Servicing Entity
@@ -42,6 +44,7 @@ The `incoming_payment.expired` event indicates that an incoming payment has expi
 Example: An incoming payment has expired and received $2.55.
 
 ```mermaid
+
 sequenceDiagram
 
 participant ASE as Account Servicing Entity
@@ -59,6 +62,7 @@ The `outgoing_payment.created` event indicates that an outgoing payment has been
 Example: An outgoing payment for $12 has been created.
 
 ```mermaid
+
 sequenceDiagram
 
 participant ASE as Account Servicing Entity
@@ -76,6 +80,7 @@ The `outgoing_payment.completed` event indicates that an outgoing payment has su
 Example: An outgoing payment for $12 has been completed. $11.50 were sent. The Account Servicing Entity keeps $0.50 as fees.
 
 ```mermaid
+
 sequenceDiagram
 
 participant ASE as Account Servicing Entity
@@ -93,6 +98,7 @@ The `outgoing_payment.failed` event indicates that an outgoing payment has eithe
 Example: An outgoing payment for $12 has failed. $8 were sent.
 
 ```mermaid
+
 sequenceDiagram
 
 participant ASE as Account Servicing Entity
@@ -110,6 +116,7 @@ The `payment_pointer.web_monetization` event indicates that a payment pointer ha
 Example: A payment pointer received $0.33
 
 ```mermaid
+
 sequenceDiagram
 
 participant ASE as Account Servicing Entity
@@ -127,6 +134,7 @@ The `payment_pointer.not_found` event indicates that a [payment pointer](/refere
 Example: The payment pointer `https://example-wallet.com/carla_garcia` was requested but does not yet exist
 
 ```mermaid
+
 sequenceDiagram
 
 participant ASE as Account Servicing Entity
@@ -143,6 +151,7 @@ The `asset.liquidity_low` event indicates that the liquidity of an [asset](../re
 Example: The asset liquidity for USD (scale: 2) drops below 100.00 USD.
 
 ```mermaid
+
 sequenceDiagram
 
 participant ASE as Account Servicing Entity
@@ -159,6 +168,7 @@ The `peer.liquidity_low` event indicates that the liquidity of a [peer](../refer
 Example: The peer liquidity for Happy Life Bank drops below 100.00 USD.
 
 ```mermaid
+
 sequenceDiagram
 
 participant ASE as Account Servicing Entity

diff --git a/packages/documentation/src/content/docs/introduction/architecture.md b/packages/documentation/src/content/docs/introduction/architecture.md
@@ -23,7 +23,7 @@ The `backend` service has four responsibilities:
 
 - Expose REST [Open Payments API](https://docs.openpayments.guide/reference) endpoints for public clients to perform account management tasks.
 - Expose an internal GraphQL Admin API for service operators to manage accounts and application settings like peering relationships.
-- Expose an [ILP connector](../concepts/interledger-protocol/connector.md) to send and receive STREAM packets with peers.
+- Expose an [ILP connector](/concepts/interledger-protocol/connector) to send and receive STREAM packets with peers.
 - Business logic to manage accounts and track balances.
 
 The `backend`'s ILP functionality includes: