added some framework to docs

aditya520 · aditya520 · commit bf983a13f48a · 2024-06-12T11:56:42.000-04:00
diff --git a/pages/express-relay/_meta.json b/pages/express-relay/_meta.json
@@ -15,16 +15,24 @@
     "type": "separator"
   },
 
+  "integrate-express-relay": "Integrate Express Relay",
+
   "-- Reference Material": {
     "title": "Reference Material",
     "type": "separator"
   },
 
+  "api-reference": "API Reference",
+  "contract-addresses": "Contract Addresses",
+  "error-codes": "Error Codes",
+
   "examples": {
     "title": "Example Application ↗"
   },
   "-- Understand Express Relay": {
     "title": "Understanding Express Relay",
     "type": "separator"
-  }
+  },
+
+  "how-express-relay-works": "How Express Relay Works"
 }
diff --git a/pages/express-relay/api-reference.mdx b/pages/express-relay/api-reference.mdx
@@ -0,0 +1,3 @@
+# API Reference
+
+Link to swagger
diff --git a/pages/express-relay/contract-addresses.mdx b/pages/express-relay/contract-addresses.mdx
@@ -0,0 +1 @@
+# Contract Address
diff --git a/pages/express-relay/error-codes.mdx b/pages/express-relay/error-codes.mdx
diff --git a/pages/express-relay/how-express-relay-works.mdx b/pages/express-relay/how-express-relay-works.mdx
@@ -0,0 +1 @@
+# Design Overview
diff --git a/pages/express-relay/how-express-relay-works/auction.mdx b/pages/express-relay/how-express-relay-works/auction.mdx
diff --git a/pages/express-relay/how-express-relay-works/relayer.mdx b/pages/express-relay/how-express-relay-works/relayer.mdx
diff --git a/pages/express-relay/index.mdx b/pages/express-relay/index.mdx
@@ -1,3 +1,13 @@
 # Introduction
 
-Express Relay
+Express Relay
+
+(Insert minimalistic architecture diagram here)
+
+## What is Express Relay?
+
+### How does Express Relay work? (Maximum 2-3 lines)
+
+### Different types of actors in Express Relay
+
+## Links to other pages
diff --git a/pages/express-relay/integrate-express-relay.mdx b/pages/express-relay/integrate-express-relay.mdx
@@ -0,0 +1,9 @@
+# How to Integrate Express Relay
+
+
+
+3-4 lines about Express Relay integration. 
+
+
+- [Searchers](./integrate-express-relay/searchers.mdx)
+- [Protocols](./integrate-express-relay/protocols.mdx)
diff --git a/pages/express-relay/integrate-express-relay/protocols.mdx b/pages/express-relay/integrate-express-relay/protocols.mdx
@@ -0,0 +1 @@
+# How to Integrate Express Relay as a Protocol
diff --git a/pages/express-relay/integrate-express-relay/searchers.mdx b/pages/express-relay/integrate-express-relay/searchers.mdx
@@ -0,0 +1 @@
+# How to Integrate Express Relay as a Searcher

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# API Reference`
	`2`	`+`
	`3`	`+Link to swagger`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# How to Integrate Express Relay as a Protocol`