primev · ckartik · Apr 4, 2024 · Apr 4, 2024 · Apr 4, 2024 · Apr 4, 2024
diff --git a/Primev Docs Testnet Ver 41c24e77a73e47e0966d54365efbbfc8.md b/Primev Docs Testnet Ver 41c24e77a73e47e0966d54365efbbfc8.md
@@ -84,7 +84,7 @@ Mev-commit's p2p network is structured to allow real-time communication across n
 
 The diagram below illustrates how **bids, commitments, and funds** flow with mev-commit, reflecting its efficiency in facilitating P2P interactions for mev actors.
 
-![https://docs.primev.xyz/flow.png](https://docs.primev.xyz/flow.png)
+![https://docs.primev.xyz/flow.png]/flow.png)
 
 ## mev-commit Details
 
@@ -298,7 +298,7 @@ After the bidder's actions, the provider proceeds to:
 
 When a bid for a transaction (txnj) is circulated through the mev-commit p2p network and the provider has made a commitment, the oracle is activated to verify whether the provider has honored this commitment.
 
-![Oracle.png](Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/Oracle.png)
+![oracle.png](Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/oracle.png)
 
 The process is as follows:
 
@@ -470,7 +470,7 @@ Users can open an issue on the GitHub repository that is associated with any iss
 
 Primev will maintain a testnet consisting of the mev-commit chain, oracle service, and hyperlane bridge to Sepolia.
 
-![https://docs.primev.xyz/chain.png](https://docs.primev.xyz/chain.png)
+![https://docs.primev.xyz/chain.png]/chain.png)
 
 ## Testnet System Requirements
 

diff --git a/README.md b/README.md
@@ -1,5 +1,22 @@
-This is the open source documentation repository for [mev-commit](https://github.com/primevprotocol/mev-commit).
+## mev-commit platform documentation
 
-# mev-commit
-mev-commit is P2P software that creates a network of execution providers and bidders. Bidders can broadcast bids to providers and receive commitments from them. A high throughput POA EVM chain settles the bids at the end of a block slot.
 
+# Contribution Guidelines
+Welcome to our documentation, we are glad to have you here!
+
+This repository contains the source code for our documentation website. If you'd like to contribute, please follow these guidelines:
+
+1. Fork the repository and create a new branch from the `main` branch.
+2. Make your changes to the markdown files.
+3. Submit a pull request to the `main` branch.
+
+## Standards and conventions
+
+### Links
+- Ensure all links that reference the documentation are linking using an absolute path. For example, to reference fund node page, you do as follows: `[fund node](/get-started/bidders/fund-node)`.
+
+### New Files
+- Ensure all files are in lowercase.
+- Ensure all files are using kebab-case. For example, the kebab-case version of "My First Preconf" is "my-first-preconf.mdx".
+
+We'd appreciate if you would run mintlify dev to verify changes locally and mintlify broken-links to ensure there aren't any broken links introduced from your changes. Thank you! :) 
diff --git a/concepts/mev-commit-chain/chain-details.mdx b/concepts/mev-commit-chain/chain-details.mdx
@@ -3,7 +3,7 @@ title: 'Chain Details'
 sidebarTitle: Chain Details
 ---
 
-mev-commit chain mainnet is set to launch soon. In the meantime, join the testnet and get familiar with its functionalities from the [Testnet](https://docs.primev.xyz/developers/mev-commit-testnet) section.
+mev-commit chain mainnet is set to launch soon. In the meantime, join the testnet and get familiar with its functionalities from the [Testnet](/developers/mev-commit-testnet) section.
 
 ## **Design**
 

diff --git a/concepts/Network Overview.mdx → concepts/network-overview.mdx b/concepts/Network Overview.mdx → concepts/network-overview.mdx
diff --git a/concepts/oracle.mdx b/concepts/oracle.mdx
@@ -38,7 +38,7 @@ _After the bidder's actions, the provider proceeds to:_
 When a bid for a transaction (txnj) is circulated through the mev-commit p2p network and the provider has made a commitment, the oracle is activated to verify whether the provider has honored this commitment.
 
 <Frame>
-  <img src="/images/Oracle.png" />
+  <img src="/images/oracle.png" />
 </Frame>
 
 The process is as follows:

diff --git a/concepts/what-is-mev-commit.mdx b/concepts/what-is-mev-commit.mdx
@@ -27,7 +27,7 @@ Providers of execution services, such as **Block Builders and Rollup Sequencers*
 
 ### **Bidders**
 
-Users bidding for execution services include **mev searchers, AA bundlers, solvers, Rollup Provers, and others seeking efficient use of block space**. For detailed roles and interactions, refer to the [Actors](https://docs.primev.xyz/concepts/overview/actors) section.
+Users bidding for execution services include **mev searchers, AA bundlers, solvers, Rollup Provers, and others seeking efficient use of block space**. For detailed roles and interactions, refer to the [Actors]/concepts/overview/actors) section.
 
 ## Bids
 

diff --git a/developers/Testnet.mdx b/developers/Testnet.mdx
@@ -71,5 +71,5 @@ Users can open an issue on the GitHub repository that is associated with any iss
 
 ## Testnet System Requirements
 
-Please refer to the System Requirements section [here.](https://docs.primev.xyz/developers/system-requirements)
+Please refer to the System Requirements section [here.]/developers/system-requirements)
-Please refer to the System Requirements section [here.]/developers/system-requirements)
+Please refer to the System Requirements section [here.](/developers/system-requirements)
-Please refer to the System Requirements section [here.]/developers/system-requirements)
+Please refer to the System Requirements section [here.](/developers/system-requirements)
 
diff --git a/developers/contracts.mdx b/developers/contracts.mdx
@@ -2,7 +2,7 @@
 
 The [mev-commit contracts](https://github.com/primevprotocol/contracts) verify and manage the movement of funds as a response to bid and commitment activities that occur on our p2p network.  
 
-For mev-commit testnet contract addresses please refer to [Testnet](https://docs.primev.xyz/developers/mev-commit-testnet) section.
+For mev-commit testnet contract addresses please refer to [Testnet]/developers/mev-commit-testnet) section.
 
 ## Contract Architecture and Functionality
 

diff --git a/developers/manual-start-mev-commit.mdx b/developers/manual-start-mev-commit.mdx
@@ -102,7 +102,7 @@ After installing `cast`, run `foundryup` to ensure it's updated.
 	--settlement-rpc-endpoint https://chainrpc.testnet.mev-commit.xyz
   ```
 
-  Once the node is started you can go through the [funding process](https://docs.primev.xyz/get-started/bidders/fund-node) to start sending bids.
+  Once the node is started you can go through the [funding process]/get-started/bidders/fund-node) to start sending bids.
 
   ### Starting as a Provider Node
   ```shell
@@ -111,4 +111,4 @@ After installing `cast`, run `foundryup` to ensure it's updated.
 	--settlement-rpc-endpoint https://chainrpc.testnet.mev-commit.xyz
   ```
 
-  In order to register as a provider please go through the [registration process](https://docs.primev.xyz/get-started/providers/register-a-provider).
+  In order to register as a provider please go through the [registration process](/get-started/providers/registering-as-a-provider).
diff --git a/get-started/bidders/fund-node.mdx b/get-started/bidders/fund-node.mdx
@@ -52,7 +52,7 @@ To add funds to your account on the mev-commit chain, you may use the testnet fa
     	--value 100ether
     ```
 
-Alternatively, utilize the bridge from Holesky for account funding. See [bridging-and-fees](https://docs.primev.xyz/get-started/bidders/bridging-and-fees).
+Alternatively, utilize the bridge from Holesky for account funding. See [bridging-and-fees]/get-started/bidders/bridging-and-fees).
 
 - **Checking Minimum Prepaid Allowance:**
 

diff --git a/get-started/bidders/My First Preconf.mdx → get-started/bidders/my-first-preconf.mdx b/get-started/bidders/My First Preconf.mdx → get-started/bidders/my-first-preconf.mdx
@@ -5,8 +5,8 @@ sidebarTitle: 'My First Preconf <3'
 
 ### Pre-requisites
 Make sure you:
-1. Get a [mev-commit Bidder Node up and running](https://docs.primev.xyz/get-started/quickstart).
-2. [Fund your node](https://docs.primev.xyz/get-started/bidders/fund-node) so you have the funds to submit bids.
+1. Get a [mev-commit Bidder Node up and running]/get-started/quickstart).
+2. [Fund your node]/get-started/bidders/fund-node) so you have the funds to submit bids.
 
 ### Submit a Bid and Receive a Preconfirmation Commitment
 

diff --git a/get-started/bidders/Submitting Bids.mdx → get-started/bidders/submitting-bids.mdx b/get-started/bidders/Submitting Bids.mdx → get-started/bidders/submitting-bids.mdx
@@ -77,7 +77,7 @@ curl -X POST http://localhost:13523/v1/bidder/bid \
 [custom Postman request](https://primev.postman.co/workspace/Team-Workspace~18870d84-94f0-4d1e-8163-db558f83d7e8/request/27192304-fab87a71-9722-46f8-825f-d9791ead6178?ctx=documentation&tab=body)
 as an alterative way to send bids. Ensure you've got the Postman agent ready to go!
 
-The REST API provides a straightforward way to submit bids using HTTP requests. For detailed usage instructions, refer to [the Bidder API documentation](https://docs.primev.xyz/api-reference/bidder/sendbid).
+The REST API provides a straightforward way to submit bids using HTTP requests. For detailed usage instructions, refer to [the Bidder API documentation]/api-reference/bidder/sendbid).
 
 ## Official Go RPC Client
 

diff --git a/get-started/providers/Consuming Bids.mdx → get-started/providers/consuming-bids.mdx b/get-started/providers/Consuming Bids.mdx → get-started/providers/consuming-bids.mdx
@@ -75,5 +75,5 @@ Providers that have registered in the mev-commit registry will automatically sta
 
 ### Alternative Methods
 1. Use [https://github.com/fullstorydev/grpcurl](https://github.com/fullstorydev/grpcurl) or [https://github.com/bloomrpc/bloomrpc](https://github.com/bloomrpc/bloomrpc) or other GUI clients like [Postman](https://www.postman.com). Relevant protobuf files are available in the [mev-commit repository](https://github.com/primevprotocol/mev-commit).
-2. Check the [API docs](https://docs.primev.xyz/api-reference/introduction) to use the REST APIs. The RPC APIs are also available on the HTTP server.
+2. Check the [API docs]/api-reference/introduction) to use the REST APIs. The RPC APIs are also available on the HTTP server.
 3. Users can use the protobuf files to generate a client in language of their choice.
diff --git a/...d/providers/Registering as a Provider.mdx → ...d/providers/registering-as-a-provider.mdx b/...d/providers/Registering as a Provider.mdx → ...d/providers/registering-as-a-provider.mdx
@@ -9,7 +9,7 @@ Once a provider is registered on the network, other nodes will connect to it and
 
 You can use the provider API to stake and check your stake balance.
 
-*   Stake (make sure you've [funded your account on the mev-commit chain](https://docs.primev.xyz/get-started/bridging-funds) first).
+*   Stake (make sure you've [funded your account on the mev-commit chain]/get-started/bridging-funds) first).
 
     ```shell
     > curl -X POST localhost/v1/provider/register_stake/10000000000000000000 | jq
@@ -56,4 +56,4 @@ Once staked, peer connection logs should appear within a few minutes. You can ch
     }
     ```
 
-Congrats, your provider node is registered on mev-commit and you're ready to [consume bids](https://docs.primev.xyz/get-started/providers/Consuming%20Bids).
+Congrats, your provider node is registered on mev-commit and you're ready to [consume bids]/get-started/providers/Consuming%20Bids).
diff --git a/get-started/providers/sending-commitments.mdx b/get-started/providers/sending-commitments.mdx
@@ -11,7 +11,7 @@ Your first step is to set up a provider node. The following command will allow y
 curl -o launchmevcommit https://raw.githubusercontent.com/primevprotocol/scripts/main/launchmevcommit && chmod +x launchmevcommit && ./launchmevcommit --rpc-url https://chainrpc.testnet.mev-commit.xyz --node-type provider
 ```
 
-Now you'll want to run an emulator to simulate the accepting and rejecting of bids. You can read more about the internal builder API [here](https://docs.primev.xyz/api-reference/provider/sendprocessedbids).
+Now you'll want to run an emulator to simulate the accepting and rejecting of bids. You can read more about the internal builder API [here]/api-reference/provider/sendprocessedbids).
 
 To get started with the emulator, open a new terminal and run the following command:
 <Warning>You require Go Version 1.21.1 to run the example emulator</Warning>

diff --git a/get-started/quickstart.mdx b/get-started/quickstart.mdx
@@ -11,7 +11,7 @@ chmod +x launchmevcommit && \
 ./launchmevcommit --rpc-url https://chainrpc.testnet.mev-commit.xyz --node-type bidder
 ```
 
-This will get you going with a mev-commit node as a bidder on the network. To join the network as a **provider**, simply change the "--node-type bidder" to "--node-type provider". Next, dive into the [bidder](https://docs.primev.xyz/get-started/bidders/fund-node) or [provider](https://docs.primev.xyz/get-started/providers/register-a-provider) sections to run your operations on the network.
+This will get you going with a mev-commit node as a bidder on the network. To join the network as a **provider**, simply change the "--node-type bidder" to "--node-type provider". Next, dive into the [bidder]/get-started/bidders/fund-node) or [provider](/get-started/providers/registering-as-a-provider) sections to run your operations on the network.
 
 **Pre-requisites:**
 
@@ -28,4 +28,4 @@ This will get you going with a mev-commit node as a bidder on the network. To jo
 
 Your mev-commit node setup is done once the command execution is complete.
 
-If you want to perform a manual setup with detailed steps please skip to [manual start mev-commit](https://docs.primev.xyz/developers/manual-start-mev-commit) section.
+If you want to perform a manual setup with detailed steps please skip to [manual start mev-commit]/developers/manual-start-mev-commit) section.
diff --git a/get-started/Welcome.mdx → get-started/welcome.mdx b/get-started/Welcome.mdx → get-started/welcome.mdx
@@ -61,7 +61,7 @@ Choose the guide below that best aligns with your interests and needs:
         <br/>
         • [Registering as a Provider](https://docs.primev.xyz/get-started/providers/Registering%20as%20a%20Provider)
 
-        • [Consuming Bids](https://docs.primev.xyz/get-started/providers/Consuming%20Bids)
+        • [Consuming Bids](https://docs.primev.xyz/get-started/providers/consuming-bids)
 
         • [Sending Commitments](https://docs.primev.xyz/get-started/providers/sending-commitments)
 

diff --git a/images/Oracle.png → images/oracle.png b/images/Oracle.png → images/oracle.png
diff --git a/mint.json b/mint.json
@@ -30,24 +30,24 @@
     {
       "group": "Get Started",
       "pages": [
-        "get-started/Welcome",
+        "get-started/welcome",
         "get-started/quickstart",
         "get-started/bridging-funds",
         {
           "group": "Bidders",
           "pages": [
             "get-started/bidders/fund-node",
-            "get-started/bidders/Submitting Bids",
-            "get-started/bidders/My First Preconf",
+            "get-started/bidders/submitting-bids",
+            "get-started/bidders/my-first-preconf",
             "get-started/bidders/bidder-node-commands"
           ],
           "icon": "user-bounty-hunter"
         },
         {
           "group": "Providers",
           "pages": [
-            "get-started/providers/Registering as a Provider",
-            "get-started/providers/Consuming Bids",
+            "get-started/providers/registering-as-a-provider",
+            "get-started/providers/consuming-bids",
             "get-started/providers/sending-commitments"
           ],
           "icon": "network-wired"
@@ -60,7 +60,7 @@
         "concepts/what-is-primev",
         "concepts/what-is-mev-commit",
         "concepts/actors",
-        "concepts/Network Overview",
+        "concepts/network-overview",
         "concepts/privacy",
         "concepts/bids",
         "concepts/commitments",

diff --git a/node_modules/.bin/prettier b/node_modules/.bin/prettier
diff --git a/node_modules/.package-lock.json b/node_modules/.package-lock.json
-Original file line number
+Diff line change
@@ Expand Up @@
     ### **Bidders**
-    Users bidding for execution services include **mev searchers, AA bundlers, solvers, Rollup Provers, and others seeking efficient use of block space**. For detailed roles and interactions, refer to the [Actors](https://docs.primev.xyz/concepts/overview/actors) section.
+    Users bidding for execution services include **mev searchers, AA bundlers, solvers, Rollup Provers, and others seeking efficient use of block space**. For detailed roles and interactions, refer to the [Actors]/concepts/overview/actors) section.
     ## Bids
@@ Expand Down @@