feat: generate contract docs with forge

.github/workflows/generated-files.yaml

@@ -31,10 +31,11 @@ jobs:
       - name: Generate Go packages and typechain-types
         run: |
           yarn generate
+          yarn docs
 
       - name: Check for changes
         run: |
-          if git diff --exit-code --ignore-space-change --ignore-all-space --ignore-cr-at-eol -- pkg typechain-types; then
+          if git diff --exit-code --ignore-space-change --ignore-all-space --ignore-cr-at-eol -- docs pkg typechain-types; then
             echo "Generated Go files are up-to-date."
           else
             echo "::error::Generated files are not up-to-date. Please run 'yarn generate' locally and commit any changes."

package.json

@@ -72,12 +72,14 @@
     "build": "yarn compile && npx del-cli dist abi && npx tsc || true && npx del-cli './dist/typechain-types/**/*.js' && npx cpx './data/**/*' dist/data && npx cpx './artifacts/contracts/**/*' ./abi && npx del-cli './abi/**/*.dbg.json'",
     "compile": "npx hardhat compile --force",
     "generate": "yarn compile && ./scripts/generate_go.sh || true && ./scripts/generate_addresses.sh && yarn lint:fix",
+    "docs": "forge doc",
     "lint": "npx eslint . --ext .js,.ts",
     "lint:fix": "npx eslint . --ext .js,.ts,.json --fix",
     "prepublishOnly": "yarn build",
     "test": "yarn compile && npx hardhat test",
     "tsc:watch": "npx tsc --watch"
   },
   "types": "./dist/lib/index.d.ts",
-  "version": "0.0.8"
+  "version": "0.0.8",
+  "packageManager": "[email protected]+sha1.1959a18351b811cdeedbd484a8f86c3cc3bbaf72"
 }