From 63906d61e627461a17736fd40e4b97efffdb25e7 Mon Sep 17 00:00:00 2001 From: malgus01 Date: Sun, 21 Sep 2025 08:39:36 -0700 Subject: [PATCH 1/3] feat: Add Documentation Natspec Header Section --- makefile | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/makefile b/makefile index e8eddeb..aac910a 100644 --- a/makefile +++ b/makefile @@ -290,3 +290,7 @@ anvil-fork: ## Start Anvil forked from mainnet anvil-polygon: ## Start Anvil forked from Polygon @echo "$(BLUE)🍴 Starting Anvil forked from Polygon...$(RESET)" anvil --fork-url $(POLYGON_RPC_URL) --host 0.0.0.0 --port 8545 + +# ================================================================ +# DOCUMENTATION +# ================================================================ \ No newline at end of file From 40c1fa46845ebb8bbe533fae60803ae8a9fe816d Mon Sep 17 00:00:00 2001 From: malgus01 Date: Sun, 21 Sep 2025 08:39:53 -0700 Subject: [PATCH 2/3] feat: Add Generate documentation --- makefile | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/makefile b/makefile index aac910a..48118f0 100644 --- a/makefile +++ b/makefile @@ -293,4 +293,10 @@ anvil-polygon: ## Start Anvil forked from Polygon # ================================================================ # DOCUMENTATION -# ================================================================ \ No newline at end of file +# ================================================================ + +docs: ## Generate documentation + @echo "$(BLUE)📚 Generating documentation...$(RESET)" + mkdir -p $(DOCS_DIR) + forge doc --build --out $(DOCS_DIR) + @echo "$(GREEN)✅ Documentation generated at $(DOCS_DIR)$(RESET)" \ No newline at end of file From bb40f07b9d05816fa6a5f1ded431f4eed571fcb7 Mon Sep 17 00:00:00 2001 From: malgus01 Date: Sun, 21 Sep 2025 08:40:13 -0700 Subject: [PATCH 3/3] feat: Add Serve documentation locally --- makefile | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/makefile b/makefile index 48118f0..02f46d9 100644 --- a/makefile +++ b/makefile @@ -299,4 +299,8 @@ docs: ## Generate documentation @echo "$(BLUE)📚 Generating documentation...$(RESET)" mkdir -p $(DOCS_DIR) forge doc --build --out $(DOCS_DIR) - @echo "$(GREEN)✅ Documentation generated at $(DOCS_DIR)$(RESET)" \ No newline at end of file + @echo "$(GREEN)✅ Documentation generated at $(DOCS_DIR)$(RESET)" + +docs-serve: docs ## Serve documentation locally + @echo "$(BLUE)🌐 Serving documentation at http://localhost:3000$(RESET)" + forge doc --serve --port 3000 \ No newline at end of file