docs: Fixed typos in the Sisyphus documentation
This commit is contained in:
@@ -218,7 +218,7 @@ instructions: |
|
|||||||
ask_user_confirm --question "This will delete the legacy API module. Continue?"
|
ask_user_confirm --question "This will delete the legacy API module. Continue?"
|
||||||
```
|
```
|
||||||
|
|
||||||
Returns "User confirmed: yes" or "User confirmed: no". **Respect the answer** — if the user says no, do NOT proceed with that action.
|
Returns "User confirmed: yes" or "User confirmed: no". **Respect the answer**; if the user says no, do NOT proceed with that action.
|
||||||
|
|
||||||
### How to Use `ask_user_checkbox` (multi-select)
|
### How to Use `ask_user_checkbox` (multi-select)
|
||||||
|
|
||||||
@@ -263,10 +263,10 @@ instructions: |
|
|||||||
### Rules for User Prompts
|
### Rules for User Prompts
|
||||||
|
|
||||||
1. **Always include (Recommended)** on the option you think is best in `ask_user`
|
1. **Always include (Recommended)** on the option you think is best in `ask_user`
|
||||||
2. **Respect user choices** — never override or ignore a selection
|
2. **Respect user choices**: Never override or ignore a selection
|
||||||
3. **Don't over-prompt** — trivial decisions (variable names in small functions, formatting) don't need prompts
|
3. **Don't over-prompt**: Trivial decisions (variable names in small functions, formatting) don't need prompts
|
||||||
4. **DO prompt for**: architecture choices, file/module naming, which of multiple valid approaches to take, destructive operations, anything you're genuinely unsure about
|
4. **DO prompt for**: Architecture choices, file/module naming, which of multiple valid approaches to take, destructive operations, anything you're genuinely unsure about
|
||||||
5. **Confirm before large changes** — if a task will touch 5+ files, confirm the plan first
|
5. **Confirm before large changes**: If a task will touch 5+ files, confirm the plan first
|
||||||
|
|
||||||
## Available Tools
|
## Available Tools
|
||||||
{{__tools__}}
|
{{__tools__}}
|
||||||
|
|||||||
@@ -254,7 +254,7 @@ search_content() {
|
|||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# @cmd Ask the user to select ONE option from a list. The first option should be your recommended choice — append '(Recommended)' to its label. Returns the selected option's label text.
|
# @cmd Ask the user to select ONE option from a list. The first option should be your recommended choice; append '(Recommended)' to its label. Returns the selected option's label text.
|
||||||
# @option --question! The question to present to the user
|
# @option --question! The question to present to the user
|
||||||
# @option --options+ The list of options to present (first option = recommended, append '(Recommended)' to its label)
|
# @option --options+ The list of options to present (first option = recommended, append '(Recommended)' to its label)
|
||||||
ask_user() {
|
ask_user() {
|
||||||
|
|||||||
Reference in New Issue
Block a user