From 413412ed8fa132b061249a5831e242a2b47649c4 Mon Sep 17 00:00:00 2001
From: xu-nicolas <442629554@qq.com>
Date: Sat, 25 Apr 2026 07:27:55 +0800
Subject: [PATCH] docs: add NatSpec comment explaining Milady.sol

Explain that Milady.sol is a convenience facade file that imports
all solady modules for rapid prototyping. Closes #965.
---
 src/Milady.sol | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/src/Milady.sol b/src/Milady.sol
index 027580431b..c5f4f0b043 100644
--- a/src/Milady.sol
+++ b/src/Milady.sol
@@ -73,6 +73,19 @@ import "./utils/UpgradeableBeacon.sol";
 import "./utils/WebAuthn.sol";
 import "./utils/ext/delegatexyz/DelegateCheckerLib.sol";
 
+/// @title Milady - A Solady Facade for Rapid Prototyping
+/// @notice This is a convenience "facade" file that imports all modules of the
+/// solady library. This allows for rapid prototyping by enabling a single
+/// import statement to access the entire library:
+///
+/// ```
+/// import "solady/Milady.sol";
+/// ```
+///
+/// For production deployments, it is recommended to import only the specific
+/// modules you need to minimize bytecode size.
+///
+/// The Milady library also contains constants for the Milady Maker ecosystem.
 library Milady {
     string internal constant WEBSITE = "https://miladymaker.net";