feat(help): integrate config-help into fish's help command #33

2026-06-07T02:31:52Z

rootiest commented

2026-06-07 02:31:52 +00:00

Summary

Rename config_help → config-help (kebab-case, matching fish convention for multi-word functions)
Add functions/help.fish wrapper that intercepts help config [section] and forwards sub-topics to config-help; all other help topics pass through to fish's built-in help unchanged
Update README.md and docs/fish-config.md to use help config as the preferred syntax throughout, with a note that config-help still works directly

Details

The new help wrapper backs up the native fish help function as __original_help on first load (sourcing it from $__fish_data_dir to trigger lazy-loading correctly), then delegates help config [...] to config-help and everything else to the original. This makes offline docs feel like a natural extension of fish's built-in help system — users who already know help string or help for will intuitively try help config.

Manual Verification

Open a new fish shell and run help config — offline manual opens in the configured pager
Run help config keybindings — pager opens at the Key Bindings section
Run help config pkg — pager jumps to the pkg function entry
Run help string — standard fish documentation for string opens (not intercepted)
Run help for — standard fish documentation opens correctly
Run config-help directly — still works as before
Run config-help keybindings directly — section jump still works
Confirm functions/config_help.fish is gone and functions/config-help.fish exists

## Summary - Rename `config_help` → `config-help` (kebab-case, matching fish convention for multi-word functions) - Add `functions/help.fish` wrapper that intercepts `help config [section]` and forwards sub-topics to `config-help`; all other `help` topics pass through to fish's built-in help unchanged - Update `README.md` and `docs/fish-config.md` to use `help config` as the preferred syntax throughout, with a note that `config-help` still works directly ## Details The new `help` wrapper backs up the native fish `help` function as `__original_help` on first load (sourcing it from `$__fish_data_dir` to trigger lazy-loading correctly), then delegates `help config [...]` to `config-help` and everything else to the original. This makes offline docs feel like a natural extension of fish's built-in help system — users who already know `help string` or `help for` will intuitively try `help config`. ## Manual Verification - [x] Open a new fish shell and run `help config` — offline manual opens in the configured pager - [x] Run `help config keybindings` — pager opens at the Key Bindings section - [x] Run `help config pkg` — pager jumps to the pkg function entry - [x] Run `help string` — standard fish documentation for `string` opens (not intercepted) - [x] Run `help for` — standard fish documentation opens correctly - [x] Run `config-help` directly — still works as before - [x] Run `config-help keybindings` directly — section jump still works - [x] Confirm `functions/config_help.fish` is gone and `functions/config-help.fish` exists

rootiest added 1 commit 2026-06-07 02:31:52 +00:00

feat(help): integrate config-help into fish's help command 569d17a342

Rename config_help → config-help and add a help wrapper that
intercepts 'help config [section]', forwarding sub-topics to
config-help. Update README and docs to use 'help config' as the
preferred interface so offline docs feel like a natural extension
of fish's built-in help system.

rootiest merged commit fe1ef6f2ee into main

2026-06-07 02:32:20 +00:00

rootiest deleted branch feat/help-config-integration

2026-06-07 02:32:20 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: rootiest/fish-config#33