Document clean scripts

Author: Shigoto-dev19

scripts/clean/clean-all.sh

@@ -1,6 +1,16 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
+# Description:
+#   This script removes Node build artifacts generated by the o1js build process
+#   as well as test-related output files:
+#     - Runs the primary clean script to remove `dist/` and `src/bindings/compiled/_node_bindings`.
+#     - Deletes test report and test artifacts directories under `tests/`.
+#
+# Usage:
+#   npm run clean:all
+
+
 # shared libraries
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 source "$SCRIPT_DIR/../lib/ux.sh"

scripts/clean/clean-artifacts.sh

@@ -1,6 +1,15 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
+# Description:
+#   Deep-clean o1js build artifacts produced across multiple toolchains. This script
+#   removes compiled JS outputs, compiled node/web bindings, and intermediate outputs created
+#   by OCaml/Dune, Rust/WASM, and the Mina proof-systems build.
+#
+# Usage:
+#   npm run clean:artifacts
+
+
 # shared libraries
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 source "$SCRIPT_DIR/../lib/ux.sh"

scripts/clean/clean.sh

@@ -1,6 +1,16 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
+# Description:
+#   This script removes build artifacts generated by the o1js build process.
+#   Specifically, it cleans the `dist/` output directory and the compiled
+#   Node.js bindings under `src/bindings/compiled/_node_bindings`, which are
+#   the artifacts required to work with Node locally.
+#
+# Usage:
+#   npm run clean
+
+
 # shared libraries
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 source "$SCRIPT_DIR/../lib/ux.sh"