docs(auction): update links (#13)

* docs(contracts): improve markdown output for contracts * fix(docs): correct admonitions * chore(lint): fmt * chore(update): sitemap * chore(links): contact page * docs(fixup): update links
manifoldfinance · Jul 11, 2024 · 34dc492 · 34dc492
1 parent 1f23998
commit 34dc492
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 9 deletions.
diff --git a/docs/Developers/index.md b/docs/Developers/index.md
@@ -25,6 +25,21 @@ description: Developer related information for builders, searchers and intergrat
 
 [Payment Methods](./payment-methods.md)
 
+## API Endpoints and Analytics
+
+| URL                                                              | Description                     |
+| ---------------------------------------------------------------- | ------------------------------- |
+| [eth.xga.com](https://eth.xga.com)                               | auction mev-boost-relay         |
+| [dashboard-auth.xga.com](https://dashboard-auth.xga.com)         | auction dashboard, auth         |
+| [blockscout.xga.com](https://blockscout.xga.com)                 | blockscout                      |
+| [rpc.xga.com](https://rpc.xga.com)                               | mainnet RPC                     |
+| [op.xga.com](https://op.xga.com)                                 | mainnet XGA RPC                 |
+| [holesky-dashboard.xga.com](https://holesky-dashboard.xga.com)   | holesky auction stash board     |
+| [holesky-blockscout.xga.com](https://holesky-blockscout.xga.com) | holesky blockscout              |
+| [holesky-op.xga.com](https://holesky-op.xga.com)                 | holesky XGA RPC                 |
+| [holesky-eth.xga.com](https://holesky-eth.xga.com)               | holesky auction mev-boost-relay |
+| [holesky-rpc.xga.com](https://holesky-rpc.xga.com)               | holesky RPC                     |
+
 ## RPC Endpoints
 
 Holesky: https://holesky-eth.xga.com/ - Relay  

diff --git a/docs/Reference/Contracts/Auctioneer.md b/docs/Reference/Contracts/Auctioneer.md
@@ -1,12 +1,12 @@
 ---
-description: Auctioneer Contract
+title: Auctioneer Contract
 ---
 
 # Auctioneer.sol
 
 > [Read code on GitHub](https://github.com/manifoldfinance/xga-auctioneer-v1/blob/master/src/Auctioneer.sol)
 
-!!! note 
+!!! note
 
   Implements an auction mechanism for selling block space.
 

diff --git a/docs/Reference/Contracts/Bidder.md b/docs/Reference/Contracts/Bidder.md
@@ -14,7 +14,7 @@ title: Bidder
 function getBid(uint256 slot) external view returns (uint256[] packedBids)
 ```
 
-!!! info 
+!!! info
 
     Get the bid from a bidder for a specific slot and round.
 

diff --git a/docs/Reference/Contracts/SettlementHouse.md b/docs/Reference/Contracts/SettlementHouse.md
@@ -1,12 +1,12 @@
 ---
-description: SettlementHouse
+title: SettlementHouse
 ---
 
-# SettlementHouse.sol
+## SettlementHouse.sol
 
 > [Read code on GitHub](https://github.com/manifoldfinance/xga-auctioneer-v1/blob/master/src/SettlementHouse.sol)
 
-!!! note 
+!!! note
 
     A contract for managing bundles of transactions for a futures token.
 

diff --git a/docs/index.md b/docs/index.md
@@ -112,6 +112,19 @@ supported by Licalzi[^6], aims to mitigate dramatic underpricing.
 
 ## Suggested Links
 
+| URL                                                              | Description                     |
+| ---------------------------------------------------------------- | ------------------------------- |
+| [eth.xga.com](https://eth.xga.com)                               | auction mev-boost-relay         |
+| [dashboard-auth.xga.com](https://dashboard-auth.xga.com)         | mainnet dashboard               |
+| [blockscout.xga.com](https://blockscout.xga.com)                 | blockscout                      |
+| [rpc.xga.com](https://rpc.xga.com)                               | mainnet RPC                     |
+| [op.xga.com](https://op.xga.com)                                 | mainnet XGA RPC                 |
+| [holesky-dashboard.xga.com](https://holesky-dashboard.xga.com)   | holesky auction stash board     |
+| [holesky-blockscout.xga.com](https://holesky-blockscout.xga.com) | holesky blockscout              |
+| [holesky-op.xga.com](https://holesky-op.xga.com)                 | holesky XGA RPC                 |
+| [holesky-eth.xga.com](https://holesky-eth.xga.com)               | holesky auction mev-boost-relay |
+| [holesky-rpc.xga.com](https://holesky-rpc.xga.com)               | holesky RPC                     |
+
 ## Footnotes
 
 [^1]: Previously this was called 'above'

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,7 +2,6 @@
 # yamllint disable rule:line-length
 # yamllint disable rule:comments-indentation
 # yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
-
 repo_name: manifoldfinance/docs-xga
 repo_url: https://github.com/manifoldfinance/docs-xga
 site_author: XGA Systems
@@ -106,8 +105,10 @@ extra:
         name: Google Analytics
         checked: false
   social:
-    - icon: fontawesome/solid/rss
-      link: https://your.site/newsletter/0_newsletter_index/
+#    - icon: fontawesome/solid/rss
+#      link: https://your.site/newsletter/0_newsletter_index/
+    - icon: fontawesome/solid/envelope
+      link: https://noteforms.com/forms/xga-intake-847b2j
 
 plugins:
   - search: