docs: auto generate NATSPEC docs

rndquu · Oct 2, 2023 · dfe0e3f · dfe0e3f · ubiquibot-rndquu · Oct 2, 2023
1 parent bcb66d3
commit dfe0e3f
Show file tree

Hide file tree

Showing 91 changed files with 455 additions and 92 deletions.
diff --git a/packages/contracts/docs/src/SUMMARY.md b/packages/contracts/docs/src/SUMMARY.md
@@ -7,7 +7,7 @@
     - [❱ core](src/dollar/core/README.md)
       - [CreditClock](src/dollar/core/CreditClock.sol/contract.CreditClock.md)
       - [CreditNft](src/dollar/core/CreditNft.sol/contract.CreditNft.md)
-      - [ERC1155Ubiquity](src/dollar/core/ERC1155Ubiquity.sol/contract.ERC1155Ubiquity.md)
+      - [ERC1155Ubiquity](src/dollar/core/ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md)
       - [ERC20Ubiquity](src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md)
       - [StakingShare](src/dollar/core/StakingShare.sol/contract.StakingShare.md)
       - [UbiquityCreditToken](src/dollar/core/UbiquityCreditToken.sol/contract.UbiquityCreditToken.md)

diff --git a/packages/contracts/docs/src/src/dollar/Diamond.sol/contract.Diamond.md b/packages/contracts/docs/src/src/dollar/Diamond.sol/contract.Diamond.md
@@ -1,5 +1,5 @@
 # Diamond
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b1159e7c3923d0cfce274dbf1d6127a376670810/src/dollar/Diamond.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/bcb66d35bbc0a307e64d5a207866fc5188d3a6f8/src/dollar/Diamond.sol)
 
 Contract that implements diamond proxy pattern
 

diff --git a/packages/contracts/docs/src/src/dollar/Diamond.sol/struct.DiamondArgs.md b/packages/contracts/docs/src/src/dollar/Diamond.sol/struct.DiamondArgs.md
@@ -1,5 +1,5 @@
 # DiamondArgs
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b1159e7c3923d0cfce274dbf1d6127a376670810/src/dollar/Diamond.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/bcb66d35bbc0a307e64d5a207866fc5188d3a6f8/src/dollar/Diamond.sol)
 
 Struct used for `Diamond` constructor args
 

diff --git a/...cs/src/src/dollar/DirectGovernanceFarmer.sol/contract.DirectGovernanceFarmer.md b/...cs/src/src/dollar/DirectGovernanceFarmer.sol/contract.DirectGovernanceFarmer.md
@@ -1,5 +1,5 @@
 # DirectGovernanceFarmer
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b1159e7c3923d0cfce274dbf1d6127a376670810/src/dollar/DirectGovernanceFarmer.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/bcb66d35bbc0a307e64d5a207866fc5188d3a6f8/src/dollar/DirectGovernanceFarmer.sol)
 
 **Inherits:**
 ReentrancyGuard

diff --git a/...c/src/dollar/access/AccessControlInternal.sol/abstract.AccessControlInternal.md b/...c/src/dollar/access/AccessControlInternal.sol/abstract.AccessControlInternal.md
@@ -1,5 +1,5 @@
 # AccessControlInternal
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b1159e7c3923d0cfce274dbf1d6127a376670810/src/dollar/access/AccessControlInternal.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/bcb66d35bbc0a307e64d5a207866fc5188d3a6f8/src/dollar/access/AccessControlInternal.sol)
 
 Role-based access control system
 

diff --git a/...ages/contracts/docs/src/src/dollar/core/CreditClock.sol/contract.CreditClock.md b/...ages/contracts/docs/src/src/dollar/core/CreditClock.sol/contract.CreditClock.md
@@ -1,5 +1,5 @@
 # CreditClock
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b1159e7c3923d0cfce274dbf1d6127a376670810/src/dollar/core/CreditClock.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/bcb66d35bbc0a307e64d5a207866fc5188d3a6f8/src/dollar/core/CreditClock.sol)
 
 CreditClock contract
 

diff --git a/packages/contracts/docs/src/src/dollar/core/CreditNft.sol/contract.CreditNft.md b/packages/contracts/docs/src/src/dollar/core/CreditNft.sol/contract.CreditNft.md
@@ -1,8 +1,8 @@
 # CreditNft
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b1159e7c3923d0cfce274dbf1d6127a376670810/src/dollar/core/CreditNft.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/bcb66d35bbc0a307e64d5a207866fc5188d3a6f8/src/dollar/core/CreditNft.sol)
 
 **Inherits:**
-[ERC1155Ubiquity](/src/dollar/core/ERC1155Ubiquity.sol/contract.ERC1155Ubiquity.md), [ICreditNft](/src/dollar/interfaces/ICreditNft.sol/interface.ICreditNft.md)
+[ERC1155Ubiquity](/src/dollar/core/ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md), [ICreditNft](/src/dollar/interfaces/ICreditNft.sol/interface.ICreditNft.md)
 
 CreditNft redeemable for Dollars with an expiry block number