docs(help): prefer help config syntax; add NOTES to config-help doc block
Generate documentation / build-docs (push) Successful in 35s
Offline docs drift reminder / remind (push) Successful in 10s

- help.fish: expand SYNOPSIS/DESCRIPTION to document -w/--html, -m/--man,
  -h/--help flags; note flags are only intercepted when 'config' is argv[1]
- config-help.fish: add # NOTES section explaining help config as the
  preferred invocation; update --help banner to show both names; update
  --help USAGE/EXAMPLES output to use `help config` syntax throughout
- docs/fish-config.md: update §5.14 synopsis/examples and "Viewing" sections
  to use `help config` as primary form; inline note for direct config-help use
- README.md: update docs table to show `help config --html` / `--man`
This commit is contained in:
2026-06-08 23:04:39 -04:00
parent e86b537f6d
commit 79f8445e25
4 changed files with 62 additions and 24 deletions
+4 -2
View File
@@ -1179,6 +1179,8 @@ Add -i (interactive confirmation) to destructive commands:
config-help --html
config-help --man
Also available as: help config [SECTION] [FLAGS]
### config-update
Synopsis: config-update [-h] [-n] [-f]
@@ -1600,7 +1602,7 @@ navigation.
## As a man page
config-help --man
help config --man
Opens the compiled docs/fish-config.1 directly via man -l, bypassing
the pager fallback chain. The symlink and MANPATH are also configured
@@ -1614,7 +1616,7 @@ a completely separate command. Do not mix them up.
## In the browser (HTML)
config-help --html
help config --html
Opens docs/html/index.html in the default web browser. Browser detection
queries the system's x-scheme-handler/https MIME entry (via xdg-mime) to