From f98a5115b2f6f5d04f4c035a9d0d306de7a507dd Mon Sep 17 00:00:00 2001 From: Dhruv Chandwani Date: Fri, 6 Dec 2024 16:19:49 -0500 Subject: [PATCH] disabling cli doc auto generation until script is fixed to exclude local paths --- .husky/pre-commit | 7 ++++--- docs/zap-cli.md | 6 +++--- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/.husky/pre-commit b/.husky/pre-commit index 07bbc931fd..be6aca74e1 100755 --- a/.husky/pre-commit +++ b/.husky/pre-commit @@ -10,9 +10,10 @@ node src-script/generate-template-helper-docs.js git add docs/api.md git add docs/helpers.md -echo "🚀 > CLI doc regen.." -node src-script/generate-cli-documentation -git add docs/zap-cli.md +# Disabling until script is fixed to exclude local paths from documentation +# echo "🚀 > CLI doc regen.." +# node src-script/generate-cli-documentation +# git add docs/zap-cli.md echo "🚀 > Eslint..." npx eslint . diff --git a/docs/zap-cli.md b/docs/zap-cli.md index 13320699dd..2548addb84 100644 --- a/docs/zap-cli.md +++ b/docs/zap-cli.md @@ -1,5 +1,5 @@ # ZAP CLI - + The`zap-cli`is a command-line interface for key ZAP functionalities, enabling users to generate and manage ZCL artifacts, launch server instances, and more. `zap-cli` is ideal for those who prefer the command line, need a lightweight alternative to the full UI or need to automate certain ZAP-related tasks. @@ -25,7 +25,7 @@ Options: -p, --httpPort Port used for the HTTP server [number] [default: 9070] --studioHttpPort Port used for integration with Silicon Labs Simplicity Studio's internal HTTP server [number] [default: -1] -i, --zapFile, --zap, --in input .zap file to read in. You can also specify them without an option, directly. [string] [default: null] - -z, --zclProperties, --zcl zcl.properties file to read in. [array] [default: "/Users/dhchandw/tools/zap/zcl-builtin/silabs/zcl.json"] + -z, --zclProperties, --zcl zcl.properties file to read in. [array] [default: "/path/to/zap/zcl-builtin/silabs/zcl.json"] --sdk sdk.json file to read, for operations that act on whole SDK [string] [default: null] -g, --generationTemplate, --gen generation template metafile (gen-template.json) to read in. [array] [default: null] --uiMode, --ui Mode of the UI to begin in. Options are: ZIGBEE [string] [default: "zigbee"] @@ -70,4 +70,4 @@ Environment variables: For more information, see https://github.com/project-chip/zap/ -``` \ No newline at end of file +```