Skip to content

feat: add documentation generation and local serve support #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 21, 2025
Merged

feat: add documentation generation and local serve support #126

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
63906d6
feat: Add Documentation Natspec Header Section
malgus01 Sep 21, 2025
40c1fa4
feat: Add Generate documentation
malgus01 Sep 21, 2025
bb40f07
feat: Add Serve documentation locally
malgus01 Sep 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,3 +290,17 @@ 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
# ================================================================

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)"

docs-serve: docs ## Serve documentation locally
@echo "$(BLUE)🌐 Serving documentation at http://localhost:3000$(RESET)"
forge doc --serve --port 3000
Loading