docs(contracts): regenerate (#12)

* docs(contracts): improve markdown output for contracts * fix(docs): correct admonitions * chore(lint): fmt * chore(update): sitemap
manifoldfinance · Jul 1, 2024 · 1f23998 · 1f23998
1 parent be165b4
commit 1f23998
Show file tree

Hide file tree

Showing 9 changed files with 544 additions and 944 deletions.
diff --git a/docs/Reference/Contracts/Auctioneer.md b/docs/Reference/Contracts/Auctioneer.md
diff --git a/docs/Reference/Contracts/Bidder.md b/docs/Reference/Contracts/Bidder.md
@@ -1,42 +1,31 @@
 ---
-description: Bidder
+title: Bidder
 ---
 
 # Bidder.sol
-> [Read code on GitHub](https://github.com/manifoldfinance/xga-auctioneer-v1/blob/maaster/src/Bidder.sol)
-
-
-
 
+> [Read code on GitHub](https://github.com/manifoldfinance/xga-auctioneer-v1/blob/master/src/Bidder.sol)
 
 ## Methods
 
 ### getBid
 
-
-
 ```solidity title="Solidity"
 function getBid(uint256 slot) external view returns (uint256[] packedBids)
 ```
 
+!!! info 
 
-!!! info
-
-	Get the bid from a bidder for a specific slot and round.
-
+    Get the bid from a bidder for a specific slot and round.
 
 #### Parameters
 
-| Name | Type | Description |
-|---|---|---|
+| Name | Type    | Description       |
+| ---- | ------- | ----------------- |
 | slot | uint256 | The auction slot. |
 
 #### Returns
 
-| Name | Type | Description |
-|---|---|---|
+| Name       | Type      | Description                                                                                        |
+| ---------- | --------- | -------------------------------------------------------------------------------------------------- |
 | packedBids | uint256[] | Array of bids (in a packed format). uint256(uint128(bidPrice),uint120(itemsToBuy),uint8(bidderId)) |
-
-
-
-
diff --git a/docs/Reference/Contracts/IAccountant.md b/docs/Reference/Contracts/IAccountant.md
@@ -1,64 +1,39 @@
 ---
-description: IAccountant
+title: Interface Accountant
 ---
 
 # IAccountant.sol
-> [Read code on GitHub](https://github.com/manifoldfinance/xga-auctioneer-v1/blob/maaster/src/IAccountant.sol)
-
-
-
 
+> [Read code on GitHub](https://github.com/manifoldfinance/xga-auctioneer-v1/blob/master/src/IAccountant.sol)
 
 ## Methods
 
 ### getPayoutBalance
 
-
-
 ```solidity title="Solidity"
 function getPayoutBalance() external view returns (uint256 payoutBalance)
 ```
 
-
-
-
-
 #### Returns
 
-| Name | Type | Description |
-|---|---|---|
-| payoutBalance | uint256 | undefined |
+| Name          | Type    | Description |
+| ------------- | ------- | ----------- |
+| payoutBalance | uint256 | undefined   |
 
 ### minPayout
 
-
-
 ```solidity title="Solidity"
 function minPayout() external view returns (uint256 amount)
 ```
 
-
-
-
-
 #### Returns
 
-| Name | Type | Description |
-|---|---|---|
-| amount | uint256 | undefined |
+| Name   | Type    | Description |
+| ------ | ------- | ----------- |
+| amount | uint256 | undefined   |
 
 ### payout
 
-
-
 ```solidity title="Solidity"
 function payout() external nonpayable
 ```
-
-
-
-
-
-
-
-