From 7e4a765ad4c514748d7e6b8f7f76ccfcc43efa19 Mon Sep 17 00:00:00 2001
From: Samuel Zhou <samuel.robota@gmail.com>
Date: Mon, 27 Nov 2023 19:49:56 -0800
Subject: [PATCH] Introduce solidity-docgen in the project for generating
 documents

---
 README.md         | 18 ++++++++++++++++++
 hardhat.config.js |  5 +++++
 package.json      |  3 ++-
 3 files changed, 25 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 03688986..5a2f29fe 100644
--- a/README.md
+++ b/README.md
@@ -297,6 +297,24 @@ make slither
 
 And get your slither output.
 
+# Document Generation
+
+We use [solidity-docgen](https://github.com/OpenZeppelin/solidity-docgen) to generate the documents for smart contracts. Documents can be generated with the following command:
+
+```
+npx hardhat docgen
+```
+
+By default, the documents are generated in Markdown format in the `doc` folder of the project. Each Solidity file (`*.sol`) has its own Markdown (`*.md`) file. To update the configuration for document generation, you can update the following section in `harhat.config.js`:
+
+```
+docgen: {
+  outputDir: "./docs",
+  pages: "files"
+}
+```
+
+You can refer to the [config.ts](https://github.com/OpenZeppelin/solidity-docgen/blob/master/src/config.ts) of solidity-docgen for the full list of configurable parameters.
 
 ## Resources
 -   [Hardhat](https://hardhat.org/docs)
diff --git a/hardhat.config.js b/hardhat.config.js
index aa148f7b..72eea623 100644
--- a/hardhat.config.js
+++ b/hardhat.config.js
@@ -8,6 +8,7 @@ require("solidity-coverage");
 require('@nomiclabs/hardhat-ethers');
 require("@nomiclabs/hardhat-etherscan");
 require('@openzeppelin/hardhat-upgrades');
+require('solidity-docgen');
 
 const createFranchise = require("./script/hardhat/createFranchise.js");
 const createIPAsset = require("./script/hardhat/createIPAsset.js");
@@ -126,5 +127,9 @@ module.exports = {
   },
   mocha: {
     timeout: 20000
+  },
+  docgen: {
+    outputDir: "./docs",
+    pages: "files"
   }
 };
diff --git a/package.json b/package.json
index c944df10..19cf163e 100644
--- a/package.json
+++ b/package.json
@@ -30,7 +30,8 @@
     "prettier-plugin-solidity": "^1.1.3",
     "solhint": "^3.6.2",
     "solhint-plugin-prettier": "^0.0.5",
-    "solidity-coverage": "^0.8.2"
+    "solidity-coverage": "^0.8.2",
+    "solidity-docgen": "^0.6.0-beta.36"
   },
   "dependencies": {
     "@openzeppelin/contracts": "^4.9.3",