Added alt_command and labels to ability documentation#112
Added alt_command and labels to ability documentation#112matthewRekos wants to merge 1 commit intomasterfrom
Conversation
There was a problem hiding this comment.
Pull Request Overview
Adds documentation for new alt_command and labels fields in ability definitions to support a toggle UI feature that allows users to switch between alternative commands within the same ability.
- Added
alt_commandandlabelsfields to the sample ability YAML structure - Updated the platform block description to include the new optional fields
- Added detailed explanations of the new fields' purposes and usage
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| **Alt Command**: A second command listed in the same ability. This generates a "toggle" UI element which lets a user switch between 'command' and 'alt_command' within the same ability choice. This is recommended for abilities which accomplish similar goals but have different commands that may be confusing or require a great deal of documentation to explain. | ||
|
|
||
| **Labels**: A list of 2 strings that are the labels for the toggle added by the Alt Command field. |
There was a problem hiding this comment.
The description is unclear about what the labels represent. Consider clarifying that these labels correspond to the command and alt_command options, and explain their order (e.g., first label for command, second for alt_command).
| **Labels**: A list of 2 strings that are the labels for the toggle added by the Alt Command field. | |
| **Labels**: A list of 2 strings that are the labels for the toggle added by the Alt Command field. The first label corresponds to the `command` option, and the second label corresponds to the `alt_command` option. |
| alt_command: | ||
| './wifi.sh modify' |
There was a problem hiding this comment.
The example shows alt_command as a single quoted string but the main command is using multi-line syntax with '|'. For consistency, consider using the same YAML syntax format for both commands or explain why they differ.
| alt_command: | |
| './wifi.sh modify' | |
| alt_command: | | |
| ./wifi.sh modify |
|
Can you address the above and resubmit for Review |
Description
Documentation for mjr-dev branch of caldera - Adds alt_command, labels to ability description for alt_command toggle in operations.
Type of change
How Has This Been Tested?
Mostly manual tests - would need advisement on UI element testing
Checklist: