diff --git a/developers/bidder-api.mdx b/api-reference/bidder-api.mdx similarity index 98% rename from developers/bidder-api.mdx rename to api-reference/bidder-api.mdx index 2bd651a3..5518efe3 100644 --- a/developers/bidder-api.mdx +++ b/api-reference/bidder-api.mdx @@ -1,5 +1,6 @@ --- title: "Bidder API" +sidebarTitle: "Bidder API Overview" --- ## **Bidders** diff --git a/developers/provider-api.mdx b/api-reference/provider-api.mdx similarity index 98% rename from developers/provider-api.mdx rename to api-reference/provider-api.mdx index e140a407..f5dece4a 100644 --- a/developers/provider-api.mdx +++ b/api-reference/provider-api.mdx @@ -1,5 +1,6 @@ --- title: "Provider API" +sidebarTitle: "Provider API Overview" --- ## **Providers** diff --git a/concepts/commitments.mdx b/concepts/bids/commitments.mdx similarity index 100% rename from concepts/commitments.mdx rename to concepts/bids/commitments.mdx diff --git a/mint.json b/mint.json index b0d9ef15..d491da94 100644 --- a/mint.json +++ b/mint.json @@ -15,6 +15,20 @@ "to": "#E97D25" } }, + "topbarLinks": [ + { + "name": "Follow", + "url": "https://twitter.com/primev_xyz" + }, + { + "name": "Writings", + "url": "https://mirror.xyz/preconf.eth" + } + ], + "topbarCtaButton": { + "type": "github", + "url": "https://github.com/primev/mev-commit" + }, "tabs": [ { "name": "API Reference", @@ -29,29 +43,39 @@ { "group": "Get Started", "pages": [ - "get-started/welcome-to-primev", - "get-started/quickstart", - "get-started/faucet", - "get-started/validators", - "get-started/relays", + "get-started/welcome-to-primev" + ] + }, + { + "group": "Quickstart", + "pages": [ { - "group": "Bidders", + "group": "Providers & Bidders", "pages": [ - "get-started/bidders/first-preconf", - "get-started/bidders/bidder-node-commands" + "quickstart/providers-and-bidders/set-up-mev-commit-node", + "quickstart/providers-and-bidders/faucet", + { + "group": "Bidders", + "pages": [ + "quickstart/providers-and-bidders/bidders/first-preconf", + "quickstart/providers-and-bidders/bidders/bidder-node-commands", + "quickstart/providers-and-bidders/bidders/bidder-deposit" + ] + }, + { + "group": "Providers", + "pages": [ + "quickstart/providers-and-bidders/providers/registering-a-provider", + "quickstart/providers-and-bidders/providers/consuming-bids", + "quickstart/providers-and-bidders/providers/sending-commitments", + "quickstart/providers-and-bidders/providers/querying-for-proposers" + ] + } ], - "icon": "user-bounty-hunter" + "icon": "arrow-right-arrow-left" }, - { - "group": "Providers", - "pages": [ - "get-started/providers/registering-a-provider", - "get-started/providers/consuming-bids", - "get-started/providers/sending-commitments", - "get-started/providers/Querying-for-proposers" - ], - "icon": "network-wired" - } + "quickstart/validators", + "quickstart/relays" ] }, { @@ -61,11 +85,11 @@ "concepts/actors", "concepts/network-overview", "concepts/privacy", - "concepts/commitments", { - "group": "Bids", + "group": "Bids & Commitments", "pages": [ "concepts/bids/bid-structure", + "concepts/bids/commitments", "concepts/bids/bidder-deposit", "concepts/bids/bid-decay-mechanism" ] @@ -88,13 +112,10 @@ "pages": [ "developers/testnet", "developers/system-requirements", - "developers/provider-api", - "developers/bidder-api", - "developers/bidder-deposit", - "developers/tools-for-bid-submission", - "developers/stake-validator-keys-manually", "developers/contracts", "developers/debugging", + "developers/tools-for-bid-submission", + "developers/stake-validator-keys-manually", "developers/manual-start-mev-commit", "developers/run-mev-commit-chain-node" ] @@ -112,7 +133,11 @@ }, { "group": "API Reference", - "pages": ["api-reference/introduction"] + "pages": [ + "api-reference/introduction", + "api-reference/provider-api", + "api-reference/bidder-api" + ] }, { "group": "Provider", diff --git a/developers/bidder-deposit.mdx b/quickstart/providers-and-bidders/bidders/bidder-deposit.mdx similarity index 98% rename from developers/bidder-deposit.mdx rename to quickstart/providers-and-bidders/bidders/bidder-deposit.mdx index 98433768..56543fce 100644 --- a/developers/bidder-deposit.mdx +++ b/quickstart/providers-and-bidders/bidders/bidder-deposit.mdx @@ -1,6 +1,6 @@ --- title: "Managing Your Bidder Deposit" -sidebarTitle: Managing Your Bidder Deposit +sidebarTitle: Bidder Deposit --- **To Check Your Deposit for current window:** diff --git a/get-started/bidders/bidder-node-commands.mdx b/quickstart/providers-and-bidders/bidders/bidder-node-commands.mdx similarity index 100% rename from get-started/bidders/bidder-node-commands.mdx rename to quickstart/providers-and-bidders/bidders/bidder-node-commands.mdx diff --git a/get-started/bidders/bidder-overview.mdx b/quickstart/providers-and-bidders/bidders/bidder-overview.mdx similarity index 100% rename from get-started/bidders/bidder-overview.mdx rename to quickstart/providers-and-bidders/bidders/bidder-overview.mdx diff --git a/get-started/bidders/first-preconf.mdx b/quickstart/providers-and-bidders/bidders/first-preconf.mdx similarity index 100% rename from get-started/bidders/first-preconf.mdx rename to quickstart/providers-and-bidders/bidders/first-preconf.mdx diff --git a/get-started/faucet.mdx b/quickstart/providers-and-bidders/faucet.mdx similarity index 98% rename from get-started/faucet.mdx rename to quickstart/providers-and-bidders/faucet.mdx index a16908b6..eb0591cd 100644 --- a/get-started/faucet.mdx +++ b/quickstart/providers-and-bidders/faucet.mdx @@ -1,7 +1,6 @@ --- title: "Testnet Faucet" sidebarTitle: Testnet Faucet -icon: "faucet" --- This faucet is for Providers and Bidders only, Validators please visit the faucet links listed on [this](/get-started/validators) page diff --git a/get-started/providers/Querying-for-proposers.mdx b/quickstart/providers-and-bidders/providers/Querying-for-proposers.mdx similarity index 100% rename from get-started/providers/Querying-for-proposers.mdx rename to quickstart/providers-and-bidders/providers/Querying-for-proposers.mdx diff --git a/get-started/providers/consuming-bids.mdx b/quickstart/providers-and-bidders/providers/consuming-bids.mdx similarity index 100% rename from get-started/providers/consuming-bids.mdx rename to quickstart/providers-and-bidders/providers/consuming-bids.mdx diff --git a/get-started/providers/registering-a-provider.mdx b/quickstart/providers-and-bidders/providers/registering-a-provider.mdx similarity index 100% rename from get-started/providers/registering-a-provider.mdx rename to quickstart/providers-and-bidders/providers/registering-a-provider.mdx diff --git a/get-started/providers/sending-commitments.mdx b/quickstart/providers-and-bidders/providers/sending-commitments.mdx similarity index 100% rename from get-started/providers/sending-commitments.mdx rename to quickstart/providers-and-bidders/providers/sending-commitments.mdx diff --git a/get-started/quickstart.mdx b/quickstart/providers-and-bidders/set-up-mev-commit-node.mdx similarity index 99% rename from get-started/quickstart.mdx rename to quickstart/providers-and-bidders/set-up-mev-commit-node.mdx index 548c73c4..26dcd281 100644 --- a/get-started/quickstart.mdx +++ b/quickstart/providers-and-bidders/set-up-mev-commit-node.mdx @@ -1,8 +1,7 @@ --- title: "Quickstart Your mev-commit Node" description: "Step into the Primev ecosystem with ease. This guide covers everything you need to set up your mev-commit node, whether you're aiming to be a bidder or a provider." -sidebarTitle: Quickstart -icon: "gear" +sidebarTitle: Setup Node mode: "wide" --- diff --git a/get-started/relays.mdx b/quickstart/relays.mdx similarity index 99% rename from get-started/relays.mdx rename to quickstart/relays.mdx index 6139385e..fd388495 100644 --- a/get-started/relays.mdx +++ b/quickstart/relays.mdx @@ -1,7 +1,7 @@ --- title: Relay Guide sidebarTitle: Relays -icon: 'arrow-right-arrow-left' +icon: 'satellite-dish' --- import { ProviderRegistryAddress } from '/snippets/testnet-addresses.mdx'; diff --git a/get-started/validators.mdx b/quickstart/validators.mdx similarity index 100% rename from get-started/validators.mdx rename to quickstart/validators.mdx