detached 22aa731

docs: fix CLI reference, add gen-docs command, reorganize config docs

commit
22aa73139c0a542e555eeddfe652480f2f2c42b8
author
brice · · 2026-01-25 14:59 UTC
parent
0d35038
signature
GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email
5 files · +198 -3
Unified
UnifiedSplit
M docs/cli/index.md +30 -1
@@ -17,6 +17,7 @@ Dumber provides commands for browser management, history, sessions, and diagnost
1717 | `dumber logs` | View application logs |
1818 | `dumber purge` | Remove data and configuration |
1919 | `dumber about` | Show version information |
20+| `dumber gen-docs` | Generate documentation from CLI commands |
2021 | `dumber completion` | Generate shell completions |
2122
2223 ## Command Reference
@@ -199,9 +200,13 @@ dumber logs clear [flags]
199200 Remove dumber data and configuration.
200201
201202 ```bash
202-dumber purge
203+dumber purge [flags]
203204 ```
204205
206+| Flag | Short | Description |
207+|------|-------|-------------|
208+| `--force` | `-f` | Remove all items without prompting |
209+
205210 ### about
206211
207212 Show version and build information.
@@ -210,6 +215,30 @@ Show version and build information.
210215 dumber about
211216 ```
212217
218+### gen-docs
219+
220+Generate documentation (man pages or markdown) from CLI commands.
221+
222+```bash
223+dumber gen-docs [flags]
224+```
225+
226+| Flag | Short | Description |
227+|------|-------|-------------|
228+| `--output` | `-o` | Output directory for generated docs |
229+| `--format` | `-f` | Output format: man, markdown (default: man) |
230+
231+**Supported formats:**
232+- `man` - Unix manual pages (groff format)
233+- `markdown` - Markdown files (for websites/wikis)
234+
235+**Examples:**
236+```bash
237+dumber gen-docs # Install man pages to ~/.local/share/man/man1/
238+dumber gen-docs --format markdown # Generate markdown docs
239+dumber gen-docs --output ./man # Generate to local directory
240+```
241+
213242 ## Environment Variables
214243
215244 Configuration can be overridden via environment variables:
@@ -17,6 +17,7 @@ Dumber provides commands for browser management, history, sessions, and diagnost
17 | `dumber logs` | View application logs |17 | `dumber logs` | View application logs |
18 | `dumber purge` | Remove data and configuration |18 | `dumber purge` | Remove data and configuration |
19 | `dumber about` | Show version information |19 | `dumber about` | Show version information |
20+| `dumber gen-docs` | Generate documentation from CLI commands |
20 | `dumber completion` | Generate shell completions |21 | `dumber completion` | Generate shell completions |
21 22
22 ## Command Reference23 ## Command Reference
@@ -199,9 +200,13 @@ dumber logs clear [flags]
199 Remove dumber data and configuration.200 Remove dumber data and configuration.
200 201
201 ```bash202 ```bash
202-dumber purge203+dumber purge [flags]
203 ```204 ```
204 205
206+| Flag | Short | Description |
207+|------|-------|-------------|
208+| `--force` | `-f` | Remove all items without prompting |
209+
205 ### about210 ### about
206 211
207 Show version and build information.212 Show version and build information.
@@ -210,6 +215,30 @@ Show version and build information.
210 dumber about215 dumber about
211 ```216 ```
212 217
218+### gen-docs
219+
220+Generate documentation (man pages or markdown) from CLI commands.
221+
222+```bash
223+dumber gen-docs [flags]
224+```
225+
226+| Flag | Short | Description |
227+|------|-------|-------------|
228+| `--output` | `-o` | Output directory for generated docs |
229+| `--format` | `-f` | Output format: man, markdown (default: man) |
230+
231+**Supported formats:**
232+- `man` - Unix manual pages (groff format)
233+- `markdown` - Markdown files (for websites/wikis)
234+
235+**Examples:**
236+```bash
237+dumber gen-docs # Install man pages to ~/.local/share/man/man1/
238+dumber gen-docs --format markdown # Generate markdown docs
239+dumber gen-docs --output ./man # Generate to local directory
240+```
241+
213 ## Environment Variables242 ## Environment Variables
214 243
215 Configuration can be overridden via environment variables:244 Configuration can be overridden via environment variables:
M docs/index.md +2 -1
@@ -23,7 +23,7 @@ A browser designed for Wayland compositors that works like your favorite termina
2323 ### Configuration
2424
2525 - [Configuration Overview](./config/index.md) - All configuration options
26-- [Configuration Reference](./config/reference.md) - Quick reference table
26+- [Configuration Reference](./reference/configuration.md) - Quick reference table
2727
2828 ### CLI Reference
2929
@@ -31,6 +31,7 @@ A browser designed for Wayland compositors that works like your favorite termina
3131
3232 ### Reference
3333
34+- [Dependencies](./reference/dependencies.md) - System dependencies for Arch and Debian/Ubuntu
3435 - [Keybindings](./reference/keybindings.md) - Keyboard shortcuts reference
3536 - [Troubleshooting](./reference/troubleshooting.md) - Common issues and solutions
3637
@@ -23,7 +23,7 @@ A browser designed for Wayland compositors that works like your favorite termina
23 ### Configuration23 ### Configuration
24 24
25 - [Configuration Overview](./config/index.md) - All configuration options25 - [Configuration Overview](./config/index.md) - All configuration options
26-- [Configuration Reference](./config/reference.md) - Quick reference table26+- [Configuration Reference](./reference/configuration.md) - Quick reference table
27 27
28 ### CLI Reference28 ### CLI Reference
29 29
@@ -31,6 +31,7 @@ A browser designed for Wayland compositors that works like your favorite termina
31 31
32 ### Reference32 ### Reference
33 33
34+- [Dependencies](./reference/dependencies.md) - System dependencies for Arch and Debian/Ubuntu
34 - [Keybindings](./reference/keybindings.md) - Keyboard shortcuts reference35 - [Keybindings](./reference/keybindings.md) - Keyboard shortcuts reference
35 - [Troubleshooting](./reference/troubleshooting.md) - Common issues and solutions36 - [Troubleshooting](./reference/troubleshooting.md) - Common issues and solutions
36 37
R docs/config/reference.md → docs/reference/configuration.md +0 -0 renamed, 100% similar

renamed, 100% similar

A docs/reference/dependencies.md +164 -0
@@ -0,0 +1,164 @@
1+# Dependencies
2+
3+This page lists the system dependencies required to run Dumber on different Linux distributions.
4+
5+## Arch Linux
6+
7+### Core GTK4 and WebKit
8+
9+```bash
10+sudo pacman -S gtk4 webkitgtk-6.0
11+```
12+
13+### VA-API (Hardware Video Acceleration)
14+
15+```bash
16+sudo pacman -S libva libva-utils
17+```
18+
19+#### VA-API Drivers (install one based on GPU)
20+
21+**Intel (Broadwell and newer):**
22+```bash
23+sudo pacman -S intel-media-driver
24+```
25+
26+**Intel (older):**
27+```bash
28+sudo pacman -S libva-intel-driver
29+```
30+
31+**AMD:**
32+```bash
33+sudo pacman -S libva-mesa-driver
34+```
35+
36+**NVIDIA:**
37+```bash
38+sudo pacman -S libva-nvidia-driver # or nvidia-vaapi-driver from AUR
39+```
40+
41+### Vulkan
42+
43+```bash
44+sudo pacman -S vulkan-icd-loader
45+```
46+
47+**Intel:**
48+```bash
49+sudo pacman -S vulkan-intel
50+```
51+
52+**AMD:**
53+```bash
54+sudo pacman -S vulkan-radeon
55+```
56+
57+**NVIDIA:**
58+```bash
59+sudo pacman -S nvidia-utils # includes Vulkan
60+```
61+
62+### GStreamer Plugins (for WebKit Media Playback)
63+
64+```bash
65+sudo pacman -S gst-plugins-base gst-plugins-good gst-plugins-bad gst-plugins-ugly gst-libav
66+```
67+
68+### Verification Tools
69+
70+```bash
71+sudo pacman -S vulkan-tools # for vulkaninfo
72+```
73+
74+## Debian/Ubuntu
75+
76+### Core GTK4 and WebKit
77+
78+```bash
79+sudo apt install libgtk-4-1 libwebkitgtk-6.0-4
80+```
81+
82+### VA-API
83+
84+```bash
85+sudo apt install libva2 vainfo
86+```
87+
88+#### VA-API Drivers
89+
90+**Intel:**
91+```bash
92+sudo apt install intel-media-va-driver # or i965-va-driver for older
93+```
94+
95+**AMD:**
96+```bash
97+sudo apt install mesa-va-drivers
98+```
99+
100+**NVIDIA:**
101+Requires manual setup or third-party PPA.
102+
103+### Vulkan
104+
105+```bash
106+sudo apt install libvulkan1 vulkan-tools
107+```
108+
109+**Intel:**
110+```bash
111+sudo apt install mesa-vulkan-drivers
112+```
113+
114+**AMD:**
115+```bash
116+sudo apt install mesa-vulkan-drivers
117+```
118+
119+**NVIDIA:**
120+```bash
121+sudo apt install nvidia-vulkan-icd
122+```
123+
124+### GStreamer
125+
126+```bash
127+sudo apt install gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
128+ gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly gstreamer1.0-libav
129+```
130+
131+## Verification Commands
132+
133+### Check VA-API
134+
135+```bash
136+vainfo
137+```
138+
139+### Check Vulkan
140+
141+```bash
142+vulkaninfo | grep VK_KHR_video_
143+```
144+
145+### Monitor GPU Decoder Usage
146+
147+```bash
148+nvtop # or intel_gpu_top for Intel
149+```
150+
151+## Environment Variables
152+
153+If auto-detection fails, you can force a specific VA-API driver:
154+
155+```bash
156+# Intel (newer)
157+export LIBVA_DRIVER_NAME=iHD
158+
159+# Intel (older)
160+export LIBVA_DRIVER_NAME=i965
161+
162+# AMD
163+export LIBVA_DRIVER_NAME=radeonsi
164+```
@@ -0,0 +1,164 @@
1+# Dependencies
2+
3+This page lists the system dependencies required to run Dumber on different Linux distributions.
4+
5+## Arch Linux
6+
7+### Core GTK4 and WebKit
8+
9+```bash
10+sudo pacman -S gtk4 webkitgtk-6.0
11+```
12+
13+### VA-API (Hardware Video Acceleration)
14+
15+```bash
16+sudo pacman -S libva libva-utils
17+```
18+
19+#### VA-API Drivers (install one based on GPU)
20+
21+**Intel (Broadwell and newer):**
22+```bash
23+sudo pacman -S intel-media-driver
24+```
25+
26+**Intel (older):**
27+```bash
28+sudo pacman -S libva-intel-driver
29+```
30+
31+**AMD:**
32+```bash
33+sudo pacman -S libva-mesa-driver
34+```
35+
36+**NVIDIA:**
37+```bash
38+sudo pacman -S libva-nvidia-driver # or nvidia-vaapi-driver from AUR
39+```
40+
41+### Vulkan
42+
43+```bash
44+sudo pacman -S vulkan-icd-loader
45+```
46+
47+**Intel:**
48+```bash
49+sudo pacman -S vulkan-intel
50+```
51+
52+**AMD:**
53+```bash
54+sudo pacman -S vulkan-radeon
55+```
56+
57+**NVIDIA:**
58+```bash
59+sudo pacman -S nvidia-utils # includes Vulkan
60+```
61+
62+### GStreamer Plugins (for WebKit Media Playback)
63+
64+```bash
65+sudo pacman -S gst-plugins-base gst-plugins-good gst-plugins-bad gst-plugins-ugly gst-libav
66+```
67+
68+### Verification Tools
69+
70+```bash
71+sudo pacman -S vulkan-tools # for vulkaninfo
72+```
73+
74+## Debian/Ubuntu
75+
76+### Core GTK4 and WebKit
77+
78+```bash
79+sudo apt install libgtk-4-1 libwebkitgtk-6.0-4
80+```
81+
82+### VA-API
83+
84+```bash
85+sudo apt install libva2 vainfo
86+```
87+
88+#### VA-API Drivers
89+
90+**Intel:**
91+```bash
92+sudo apt install intel-media-va-driver # or i965-va-driver for older
93+```
94+
95+**AMD:**
96+```bash
97+sudo apt install mesa-va-drivers
98+```
99+
100+**NVIDIA:**
101+Requires manual setup or third-party PPA.
102+
103+### Vulkan
104+
105+```bash
106+sudo apt install libvulkan1 vulkan-tools
107+```
108+
109+**Intel:**
110+```bash
111+sudo apt install mesa-vulkan-drivers
112+```
113+
114+**AMD:**
115+```bash
116+sudo apt install mesa-vulkan-drivers
117+```
118+
119+**NVIDIA:**
120+```bash
121+sudo apt install nvidia-vulkan-icd
122+```
123+
124+### GStreamer
125+
126+```bash
127+sudo apt install gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
128+ gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly gstreamer1.0-libav
129+```
130+
131+## Verification Commands
132+
133+### Check VA-API
134+
135+```bash
136+vainfo
137+```
138+
139+### Check Vulkan
140+
141+```bash
142+vulkaninfo | grep VK_KHR_video_
143+```
144+
145+### Monitor GPU Decoder Usage
146+
147+```bash
148+nvtop # or intel_gpu_top for Intel
149+```
150+
151+## Environment Variables
152+
153+If auto-detection fails, you can force a specific VA-API driver:
154+
155+```bash
156+# Intel (newer)
157+export LIBVA_DRIVER_NAME=iHD
158+
159+# Intel (older)
160+export LIBVA_DRIVER_NAME=i965
161+
162+# AMD
163+export LIBVA_DRIVER_NAME=radeonsi
164+```
M docs/reference/index.md +2 -1
@@ -2,10 +2,11 @@
22
33 ## Quick Links
44
5+- [Configuration](./configuration.md) - All config keys
6+- [Dependencies](./dependencies.md) - System dependencies for Arch and Debian/Ubuntu
57 - [Keybindings](./keybindings.md) - All keyboard shortcuts
68 - [Troubleshooting](./troubleshooting.md) - Common issues and solutions
79
810 ## Related
911
10-- [Configuration Reference](../config/reference.md) - All config keys
1112 - [CLI Commands](../cli/index.md) - Command-line interface
@@ -2,10 +2,11 @@
2 2
3 ## Quick Links3 ## Quick Links
4 4
5+- [Configuration](./configuration.md) - All config keys
6+- [Dependencies](./dependencies.md) - System dependencies for Arch and Debian/Ubuntu
5 - [Keybindings](./keybindings.md) - All keyboard shortcuts7 - [Keybindings](./keybindings.md) - All keyboard shortcuts
6 - [Troubleshooting](./troubleshooting.md) - Common issues and solutions8 - [Troubleshooting](./troubleshooting.md) - Common issues and solutions
7 9
8 ## Related10 ## Related
9 11
10-- [Configuration Reference](../config/reference.md) - All config keys
11 - [CLI Commands](../cli/index.md) - Command-line interface12 - [CLI Commands](../cli/index.md) - Command-line interface

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 8

Tags 42

↑↓ moveenter openesc close