chore(docs): codegen reference docs for nargo CLI (#4149)

# Description

## Problem\*

Resolves #4136 
Resolves AztecProtocol/dev-rel#128
## Summary\*

This PR codegens the reference material for the nargo CLI to avoid us
having to copy documentation from the code over to a markdown file.

The exact format of the codegenned markdown isn't final and we can
iterate on this but it guarantees completeness.

## Additional Context


## Documentation\*

Check one:
- [ ] No documentation needed.
- [x] Documentation included in this PR.
- [ ] **[Exceptional Case]** Documentation to be submitted in a separate
PR.

# PR Checklist\*

- [x] I have tested the changes locally.
- [x] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.

.github/workflows/docs-pr.yml

@@ -53,6 +53,14 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+
+      - name: Setup toolchain
+        uses: dtolnay/[email protected]
+
+      - uses: Swatinem/rust-cache@v2
+        with:
+          key: x86_64-unknown-linux-gnu
+          save-if: false
 
       - name: Setup toolchain
         uses: dtolnay/[email protected]

deny.toml

@@ -98,4 +98,7 @@ unknown-git = "deny"
 #
 # crates.io rejects git dependencies so anything depending on these is unpublishable and you'll ruin my day
 # when I find out.
-allow-git = ["https://github.com/jfecher/chumsky"]
+allow-git = [
+    "https://github.com/jfecher/chumsky",
+    "https://github.com/noir-lang/clap-markdown",
+]

docs/package.json

@@ -3,7 +3,7 @@
   "version": "0.0.0",
   "private": true,
   "scripts": {
-    "preprocess": "yarn node ./scripts/preprocess/index.js",
+    "preprocess": "./scripts/codegen_nargo_reference.sh && yarn node ./scripts/preprocess/index.js",
     "start": "yarn preprocess && docusaurus start",
     "build": "yarn preprocess && yarn version::stables && docusaurus build",
     "version::stables": "ts-node ./scripts/setStable.ts",

docs/scripts/codegen_nargo_reference.sh

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+set -eu
+
+cd $(dirname "$0")/..
+
+REFERENCE_DIR="./processed-docs/reference"
+NARGO_REFERENCE="$REFERENCE_DIR/nargo_commands.md"
+rm -f $NARGO_REFERENCE
+mkdir -p $REFERENCE_DIR
+
+echo "---
+title: Nargo
+description:
+  Noir CLI Commands for Noir Prover and Verifier to create, execute, prove and verify programs,
+  generate Solidity verifier smart contract and compile into JSON file containing ACIR
+  representation and ABI of circuit.
+keywords:
+  [
+    Nargo,
+    Noir CLI,
+    Noir Prover,
+    Noir Verifier,
+    generate Solidity verifier,
+    compile JSON file,
+    ACIR representation,
+    ABI of circuit,
+    TypeScript,
+  ]
+sidebar_position: 0
+---
+" > $NARGO_REFERENCE
+
+cargo run -F codegen-docs -- info >> $NARGO_REFERENCE

tooling/nargo_cli/Cargo.toml

@@ -48,6 +48,7 @@ termcolor = "1.1.2"
 color-eyre = "0.6.2"
 tokio = { version = "1.0", features = ["io-std"] }
 dap.workspace = true
+clap-markdown = { git = "https://github.com/noir-lang/clap-markdown", rev = "450d759532c88f0dba70891ceecdbc9ff8f25d2b", optional = true }
 
 # Backends
 backend-interface = { path = "../backend_interface" }
@@ -83,3 +84,6 @@ harness = false
 [[bench]]
 name = "iai"
 harness = false
+
+[features]
+codegen-docs = ["dep:clap-markdown"]

tooling/nargo_cli/src/cli/mod.rs

@@ -83,6 +83,9 @@ enum NargoCommand {
 }
 
 pub(crate) fn start_cli() -> eyre::Result<()> {
+    #[cfg(feature = "codegen-docs")]
+    return codegen_docs();
+
     let NargoCli { command, mut config } = NargoCli::parse();
 
     // If the provided `program_dir` is relative, make it absolute by joining it to the current directory.
@@ -126,3 +129,10 @@ pub(crate) fn start_cli() -> eyre::Result<()> {
 
     Ok(())
 }
+
+#[cfg(feature = "codegen-docs")]
+fn codegen_docs() -> eyre::Result<()> {
+    let markdown: String = clap_markdown::help_markdown::<NargoCli>();
+    println!("{markdown}");
+    Ok(())
+}