From 3c67307c54de2f9bb86c7ac9beaa3b29b9a94ce4 Mon Sep 17 00:00:00 2001
From: 0xneves <asguilift@hotmail.com>
Date: Sat, 13 Jan 2024 13:17:28 -0300
Subject: [PATCH] feat: move solidity-docgen to a general folder and compact
 repository config files

- Create solidity-docgen folder inside docs
- Change the output of solidity-docgen into docs/solidity-docgen
- Move general repo files into the docs folder
---
 CODE_OF_CONDUCT.md => docs/CODE_OF_CONDUCT.md         | 0
 CONTRIBUTING.md => docs/CONTRIBUTING.md               | 0
 SECURITY.md => docs/SECURITY.md                       | 0
 docs/{ => solidity-docgen}/SwapFactory.md             | 0
 docs/{ => solidity-docgen}/Swaplace.md                | 0
 docs/{ => solidity-docgen}/echidna/TestSwapFactory.md | 0
 docs/{ => solidity-docgen}/echidna/TestSwaplace.md    | 0
 docs/{ => solidity-docgen}/interfaces/IERC165.md      | 0
 docs/{ => solidity-docgen}/interfaces/IErrors.md      | 0
 docs/{ => solidity-docgen}/interfaces/ISwap.md        | 0
 docs/{ => solidity-docgen}/interfaces/ISwapFactory.md | 0
 docs/{ => solidity-docgen}/interfaces/ISwaplace.md    | 0
 docs/{ => solidity-docgen}/interfaces/ITransfer.md    | 0
 hardhat.config.ts                                     | 2 +-
 14 files changed, 1 insertion(+), 1 deletion(-)
 rename CODE_OF_CONDUCT.md => docs/CODE_OF_CONDUCT.md (100%)
 rename CONTRIBUTING.md => docs/CONTRIBUTING.md (100%)
 rename SECURITY.md => docs/SECURITY.md (100%)
 rename docs/{ => solidity-docgen}/SwapFactory.md (100%)
 rename docs/{ => solidity-docgen}/Swaplace.md (100%)
 rename docs/{ => solidity-docgen}/echidna/TestSwapFactory.md (100%)
 rename docs/{ => solidity-docgen}/echidna/TestSwaplace.md (100%)
 rename docs/{ => solidity-docgen}/interfaces/IERC165.md (100%)
 rename docs/{ => solidity-docgen}/interfaces/IErrors.md (100%)
 rename docs/{ => solidity-docgen}/interfaces/ISwap.md (100%)
 rename docs/{ => solidity-docgen}/interfaces/ISwapFactory.md (100%)
 rename docs/{ => solidity-docgen}/interfaces/ISwaplace.md (100%)
 rename docs/{ => solidity-docgen}/interfaces/ITransfer.md (100%)

diff --git a/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
similarity index 100%
rename from CODE_OF_CONDUCT.md
rename to docs/CODE_OF_CONDUCT.md
diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md
similarity index 100%
rename from CONTRIBUTING.md
rename to docs/CONTRIBUTING.md
diff --git a/SECURITY.md b/docs/SECURITY.md
similarity index 100%
rename from SECURITY.md
rename to docs/SECURITY.md
diff --git a/docs/SwapFactory.md b/docs/solidity-docgen/SwapFactory.md
similarity index 100%
rename from docs/SwapFactory.md
rename to docs/solidity-docgen/SwapFactory.md
diff --git a/docs/Swaplace.md b/docs/solidity-docgen/Swaplace.md
similarity index 100%
rename from docs/Swaplace.md
rename to docs/solidity-docgen/Swaplace.md
diff --git a/docs/echidna/TestSwapFactory.md b/docs/solidity-docgen/echidna/TestSwapFactory.md
similarity index 100%
rename from docs/echidna/TestSwapFactory.md
rename to docs/solidity-docgen/echidna/TestSwapFactory.md
diff --git a/docs/echidna/TestSwaplace.md b/docs/solidity-docgen/echidna/TestSwaplace.md
similarity index 100%
rename from docs/echidna/TestSwaplace.md
rename to docs/solidity-docgen/echidna/TestSwaplace.md
diff --git a/docs/interfaces/IERC165.md b/docs/solidity-docgen/interfaces/IERC165.md
similarity index 100%
rename from docs/interfaces/IERC165.md
rename to docs/solidity-docgen/interfaces/IERC165.md
diff --git a/docs/interfaces/IErrors.md b/docs/solidity-docgen/interfaces/IErrors.md
similarity index 100%
rename from docs/interfaces/IErrors.md
rename to docs/solidity-docgen/interfaces/IErrors.md
diff --git a/docs/interfaces/ISwap.md b/docs/solidity-docgen/interfaces/ISwap.md
similarity index 100%
rename from docs/interfaces/ISwap.md
rename to docs/solidity-docgen/interfaces/ISwap.md
diff --git a/docs/interfaces/ISwapFactory.md b/docs/solidity-docgen/interfaces/ISwapFactory.md
similarity index 100%
rename from docs/interfaces/ISwapFactory.md
rename to docs/solidity-docgen/interfaces/ISwapFactory.md
diff --git a/docs/interfaces/ISwaplace.md b/docs/solidity-docgen/interfaces/ISwaplace.md
similarity index 100%
rename from docs/interfaces/ISwaplace.md
rename to docs/solidity-docgen/interfaces/ISwaplace.md
diff --git a/docs/interfaces/ITransfer.md b/docs/solidity-docgen/interfaces/ITransfer.md
similarity index 100%
rename from docs/interfaces/ITransfer.md
rename to docs/solidity-docgen/interfaces/ITransfer.md
diff --git a/hardhat.config.ts b/hardhat.config.ts
index 5c4efed..2c5ee05 100644
--- a/hardhat.config.ts
+++ b/hardhat.config.ts
@@ -68,7 +68,7 @@ const config: HardhatUserConfig = {
   },
   defaultNetwork: "hardhat",
   docgen: {
-    outputDir: "docs",
+    outputDir: "docs/solidity-docgen",
     pages: "files",
   },
   gasReporter: {