Skip to content

Commit b40532f

Browse files
committed
docs: update documentation for v0.4.0 features and requirements
1 parent 641577f commit b40532f

File tree

3 files changed

+49
-2
lines changed

3 files changed

+49
-2
lines changed

docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Welcome to the ASK (Agent Skills Kit) documentation.
1111
| [Skill Sources](skill-sources.md) | Understanding and configuring skill sources |
1212
| [Skill Format](skill-format.md) | Creating skills with SKILL.md |
1313
| [Configuration](configuration.md) | ask.yaml and ask.lock configuration |
14+
| [Troubleshooting](troubleshooting.md) | Common issues and solutions |
15+
| [Architecture](architecture.md) | Internal design and structure |
1416

1517
## Getting Help
1618

docs/commands.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,51 @@ ask repo add my-org/skills
187187

188188
Remove a skill source.
189189

190-
```bash
191190
ask repo remove <name>
192191
```
192+
193+
---
194+
195+
## Utilities
196+
197+
### ask benchmark
198+
199+
Run performance benchmarks to measure CLI speed.
200+
201+
```bash
202+
ask benchmark
203+
```
204+
205+
**What it does:**
206+
- Measures cold and hot search performance
207+
- Measures config load time
208+
- Helps diagnose performance issues
209+
210+
---
211+
212+
### ask completion
213+
214+
Generate shell completion scripts.
215+
216+
```bash
217+
ask completion [bash|zsh|fish|powershell]
218+
```
219+
220+
---
221+
222+
## Global Flags
223+
224+
### --offline
225+
226+
Run specific commands in offline mode.
227+
228+
```bash
229+
ask skill search <keyword> --offline
230+
ask skill outdated --offline
231+
```
232+
233+
**What it does:**
234+
- Disables all network requests
235+
- Forces usage of local cache for search
236+
- Skips remote checks for updates
237+
- Useful for air-gapped environments or low connectivity

docs/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This guide covers all methods of installing ASK on your system.
55
## Requirements
66

77
- **Operating System**: macOS, Linux, or Windows
8-
- **Go** (optional): 1.21+ if building from source
8+
- **Go** (optional): 1.24+ if building from source
99

1010
---
1111

0 commit comments

Comments
 (0)