docs: docgen

Author: jdubpark

hardhat.config.ts

@@ -7,10 +7,11 @@ import * as tdly from "@tenderly/hardhat-tenderly" // also import tdly for setup
 import "@typechain/hardhat"
 // import "@openzeppelin/hardhat-upgrades"
 import "hardhat-gas-reporter"
-import "solidity-coverage"
 import "hardhat-deploy"
 import { HardhatConfig, HardhatUserConfig } from "hardhat/types"
 import "hardhat-contract-sizer" // npx hardhat size-contracts
+import "solidity-coverage"
+import "solidity-docgen"
 
 require("dotenv").config()
 
@@ -118,6 +119,10 @@ const config: HardhatUserConfig = {
     outDir: "typechain",
     target: "ethers-v6",
   },
+  docgen: {
+    outputDir: "./docs",
+    pages: "files"
+  }
 }
 
 export default config

package.json

@@ -16,7 +16,8 @@
     "lint:sol:fix": "prettier --log-level warn --ignore-path .gitignore '{contracts,test}/**/*.sol' --write",
     "solhint": "solhint '{contracts,test}/**/*.sol'",
     "test": "npx hardhat test",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "docgen": "hardhat docgen"
   },
   "author": "StoryProtocol",
   "license": "MIT",
@@ -41,6 +42,7 @@
     "hardhat-deploy": "^0.11.45",
     "hardhat-deploy-ethers": "^0.4.1",
     "hardhat-gas-reporter": "^1.0.10",
+    "husky": "^8.0.0",
     "minimatch": "^9.0.3",
     "mocha": "^10.2.0",
     "prettier": "^3.0.0",
@@ -49,9 +51,9 @@
     "solhint-community": "^3.7.0",
     "solhint-plugin-prettier": "^0.1.0",
     "solidity-coverage": "^0.8.6",
+    "solidity-docgen": "^0.6.0-beta.36",
     "ts-node": "^10.9.2",
-    "typechain": "^8.3.2",
-    "husky": "^8.0.0"
+    "typechain": "^8.3.2"
   },
   "dependencies": {
     "@openzeppelin/contracts": "5.0.1",

yarn.lock

@@ -3133,7 +3133,7 @@ graphemer@^1.4.0:
   resolved "https://registry.yarnpkg.com/graphemer/-/graphemer-1.4.0.tgz#fb2f1d55e0e3a1849aeffc90c4fa0dd53a0e66c6"
   integrity sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==
 
-handlebars@^4.0.1:
+handlebars@^4.0.1, handlebars@^4.7.7:
   version "4.7.8"
   resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.8.tgz#41c42c18b1be2365439188c77c6afae71c0cd9e9"
   integrity sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==
@@ -5005,7 +5005,7 @@ solhint@^4.1.1:
   optionalDependencies:
     prettier "^2.8.3"
 
-solidity-ast@^0.4.51:
+solidity-ast@^0.4.38, solidity-ast@^0.4.51:
   version "0.4.55"
   resolved "https://registry.yarnpkg.com/solidity-ast/-/solidity-ast-0.4.55.tgz#00b685e6eefb2e8dfb67df1fe0afbe3b3bfb4b28"
   integrity sha512-qeEU/r/K+V5lrAw8iswf2/yfWAnSGs3WKPHI+zAFKFjX0dIBVXEU/swQ8eJQYHf6PJWUZFO2uWV4V1wEOkeQbA==
@@ -5043,6 +5043,14 @@ solidity-coverage@^0.8.6:
     shelljs "^0.8.3"
     web3-utils "^1.3.6"
 
+solidity-docgen@^0.6.0-beta.36:
+  version "0.6.0-beta.36"
+  resolved "https://registry.yarnpkg.com/solidity-docgen/-/solidity-docgen-0.6.0-beta.36.tgz#9c76eda58580fb52e2db318c22fe3154e0c09dd1"
+  integrity sha512-f/I5G2iJgU1h0XrrjRD0hHMr7C10u276vYvm//rw1TzFcYQ4xTOyAoi9oNAHRU0JU4mY9eTuxdVc2zahdMuhaQ==
+  dependencies:
+    handlebars "^4.7.7"
+    solidity-ast "^0.4.38"
+
 source-map-support@^0.5.13:
   version "0.5.21"
   resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.5.21.tgz#04fe7c7f9e1ed2d662233c28cb2b35b9f63f6e4f"