chore: add docs for Justfile

bench: 760228

Author: DeveloperPaul123

Justfile

@@ -2,15 +2,22 @@ set windows-shell := ["pwsh.exe", "-NoLogo", "-Command"]
 
 default: (build)
 
+[group('dev')]
+[doc('Build the project (default is debug)')]
 build config="debug":
     echo "Building the project..."
     cargo build --workspace --all-features {{ if config=="release" {"--release"} else {""} }}
 
+[group('dev')]
+[doc('Build and run tests (default is debug)')]
 test config="debug":
     echo "Running tests..."
     cargo test --workspace --all-features {{ if config=="release" {"--release"} else {""} }} -- --include-ignored
 
 export LLVM_PROFILE_FILE:="./target/coverage/byte_knight-%p-%m.profraw"
+
+[group('dev')]
+[doc('Generate test coverage')]
 coverage: (build "debug")
     echo "Running tests with coverage..."
     mkdir -p target/coverage
@@ -21,6 +28,8 @@ coverage: (build "debug")
         --branch --keep-only "src/*" --keep-only "engine/*" --keep-only "chess/*" \
         --ignore "src/bin/byte-knight/*" --ignore "chess/src/perft*"
 
+[group('dev')]
+[doc('Purge files generated by @coverage')]
 purge-coverage:
     echo "Purging coverage data..."
     rm -rf *.profraw
@@ -30,42 +39,65 @@ purge-coverage:
     rm -rf chess/*.profraw
     rm -rf engine/*.profraw
 
+[group('dev')]
+[doc('Run clippy')]
 lint:
     cargo clippy --all --all-features --tests -- -D warnings
 
+[group('chess')]
+[group('performance')]
+[doc('Run sarch benchmark - required before committing for OpenBench.')]
 search-bench:
     echo "Running search benchmark..."
     cargo rustc --release --bin byte-knight -- -C target-cpu=native
     ./target/release/byte-knight bench
 
+[group('chess')]
+[doc('Run perft at a specified depth')]
 perft depth:
     echo "Running perft..."
     cargo run --release --bin perft -- -d {{ depth }}
 
+[group('chess')]
+[doc('Run perft over the EPD test suite')]
 perft-epd:
     echo "Running EPD perft test suite..."
     cargo run --release --bin perft -- --epd-file data/standard.epd
 
+[group('chess')]
+[group('performance')]
+[doc('Run perft benchmark over the EPD test suite')]
 perft-bench:
     echo "Running perft benchmark..."
     cargo run --release --bin perft-bench -- -e data/standard.epd
 
+[group('chess')]
+[doc('Generate magic numbers use for magic bitboards')]
 magics:
     echo "Generating magics..."
     cargo run --release --bin generate_magics
 
+[group('chess')]
+[doc('Verify that generated Zobrist hashes are unique')]
 verify-zobrist:
     echo "Verifying Zobrist hash..."
     cargo run --release --bin verify_zobrist
 
+[group('dev')]
+[doc('Generate release binaries for given target.')]
 release target:
     echo "Building release binaries..."
     cargo rustc --release --bin byte-knight --target={{ target }}
 
+[group('dev')]
+[doc('Caches the release binary to bk-main for testing.')]
 cache-main: (build "release")
     echo "Caching binary for testing..."
     cp target/release/byte-knight ./bk-main
 
+[group('dev')]
+[group('chess')]
+[doc('Run the engine against itself. Requires @cache-main to be run first and fastchess to be installed.')]
 compare-to-main engine1: (build "release")
     echo "Comparing {{ engine1 }} to bk-main"
     fastchess -engine cmd="{{ engine1 }}" name="dev" -engine cmd="./bk-main" name="bk-main" -openings file="./data/Pohl.epd" format=epd order=random -each tc=10+0.1 -rounds 200 -repeat -concurrency 8 -sprt elo0=0 elo1=5 alpha=0.05 beta=0.1 model=normalized -output format=cutechess