Fix CLI reference generation (#3403)

# Description of Changes

Add back the instructions for regenerating CLI docs, which were removed
in #3343. I also made a
script for it.

This also fixes the CI checking this file, which was silently broken in
the same PR.

I have **not** verified that this works in Git Bash in Windows.

# API and ABI breaking changes

None

# Expected complexity level and risk

1

# Testing
- [x] CI passes
- [x] CI fails if I change the CLI reference
- [x] CLI reference looks visually reasonable on a local `pnpm dev`

---------

Signed-off-by: Zeke Foppa <196249+bfops@users.noreply.github.com>
Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>

Author: bfops

crates/cli/src/subcommands/init.rs

@@ -123,7 +123,7 @@ pub fn cli() -> clap::Command {
                 .long("project-path")
                 .value_name("PATH")
                 .value_parser(clap::value_parser!(PathBuf))
-                .help("Directory where the project will be created (defaults to ./<PROJECT_NAME>)"),
+                .help("Directory where the project will be created (defaults to `./<PROJECT_NAME>`)"),
         )
         .arg(Arg::new("project-name").value_name("PROJECT_NAME").help("Project name"))
         .arg(

docs/README.md

@@ -38,8 +38,10 @@ git push -u origin a-branch-name-that-describes-my-change
 6. Go to our GitHub and open a PR that references your branch in your fork on
    your GitHub
 
-### Docusaurus Documentation
+### CLI Reference Section
+To regenerate the CLI reference section, run `pnpm generate-cli-docs`.
 
+### Docusaurus Documentation
 For more information on how to use Docusaurus, see the
 [Docusaurus documentation](https://docusaurus.io/docs).