Add markdown docs generation (#2437)

### Description

Adds markdown doc generation to solidity and token package

May be preferable to our gitbook contract API docs

solidity/.gitignore

@@ -10,3 +10,4 @@ coverage.json
 # Foundry
 out
 forge-cache
+docs

solidity/README.md

@@ -4,10 +4,12 @@ On-chain implementations of Hyperlane in Solidity.
 
 ## Setup
 
-- `npm install --dev`
+- `yarn install`
-- `brew install jq`   OR   `sudo apt-get install jq`
 
 ## Build
 
-- `npm run compile`
+- `yarn build`
-- `npm run test`
+
+## Test
+
+- `yarn test`

solidity/package.json

@@ -32,7 +32,8 @@
   "files": [
     "/dist",
     "/contracts",
-    "/interfaces"
+    "/interfaces",
+    "/docs"
   ],
   "homepage": "https://www.hyperlane.xyz",
   "keywords": [
@@ -47,6 +48,7 @@
     "lint": "solhint contracts/**/*.sol",
     "clean": "hardhat clean && rm -rf ./dist ./cache",
     "coverage": "hardhat coverage && forge coverage --report lcov",
+    "docs": "forge doc",
     "prettier": "prettier --write ./contracts ./test",
     "test": "hardhat test && yarn test:forge",
     "test:forge": "forge test -vvv",

typescript/token/.gitignore

@@ -6,4 +6,7 @@ dist/
 coverage/
 coverage.json
 *.swp
-.yarn/install-state.gz
+.yarn/install-state.gz
+# foundry
+docs
+out

typescript/token/foundry.toml

@@ -0,0 +1,7 @@
+[profile.default]
+src = "contracts"
+out = "out"
+libs = ["lib"]
+allow_paths = ["../../node_modules", "../../solidity"]
+
+# See more config options https://github.com/foundry-rs/foundry/tree/master/config

typescript/token/package.json

@@ -35,7 +35,8 @@
   },
   "files": [
     "/dist",
-    "/contracts"
+    "/contracts",
+    "/docs"
   ],
   "homepage": "https://www.hyperlane.xyz",
   "keywords": [
@@ -51,7 +52,8 @@
     "url": "https://github.com/hyperlane-xyz/hyperlane-token"
   },
   "scripts": {
-    "clean": "hardhat clean && rm -rf dist cache src/types",
+    "clean": "hardhat clean && rm -rf dist cache src/types && forge clean",
+    "docs": "forge doc",
     "build": "hardhat compile && tsc",
     "coverage": "hardhat coverage",
     "lint": "solhint contracts/**/*.sol && eslint . --ext .ts",

typescript/token/remappings.txt

@@ -0,0 +1,3 @@
+@openzeppelin=../../node_modules/@openzeppelin
+@hyperlane-xyz=../../node_modules/@hyperlane-xyz
+forge-std/=lib/forge-std/src/