From b3ba4bb8b33063c9c111f01c2072a25abd0e8937 Mon Sep 17 00:00:00 2001 From: Joel Hamill <11722533+joel-hamill@users.noreply.github.com> Date: Thu, 16 Oct 2025 13:10:20 -0700 Subject: [PATCH] Add docs local build/testing info --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 00f3bdbe58..d60eccc122 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -271,6 +271,13 @@ See the [Autocompletion](pkg/cmd/AUTOCOMPLETION.md) resource for implementation For most resource types, a `delete` command should support multiple arguments. The exceptions are resources which do not have an ID (e.g. ACLs, role bindings) or unique resources (e.g. the Schema Registry cluster). See [Supporting Multiple Deletion](pkg/deletion/README.md) for instructions on how to write such commands. +### Building the documentation +You can build the CLI documentation locally by running this command from the root directory. This will generate documentation in [RST](https://www.sphinx-doc.org/en/master/index.html) format in the `cli/docs` directory. + +``` +go run cmd/docs/main.go +``` + ### Opening a PR That's it! As you can see, the process of adding a new CLI command is pretty straightforward. You can open a PR if: