docs: Generate docs and add release instructions

docs/RELEASE.md

@@ -0,0 +1,6 @@
+# How to make a new release
+
+1. Bump version number in `kpxhs.cabal`, `src/kpxhs/Constants.hs`, and `docs/src/part-1.md`
+2. Run `make` in the `docs` dir
+3. Push to Github and inspect CI logs
+4. Add a release tag and push to Github

docs/out/kpxhs.1

@@ -1,7 +1,7 @@
 '\" t
-.\" Automatically generated by Pandoc 2.14.1
+.\" Automatically generated by Pandoc 2.14.2
 .\"
-.TH "kpxhs" "1" "" "Version 1.8" "kpxhs manual"
+.TH "kpxhs" "1" "" "Version 1.9" "kpxhs manual"
 .hy
 .SH NAME
 .PP
@@ -38,11 +38,10 @@ Ignores number of dashes.
 Go up a directory, or attempt to quit if in root directory.
 .TP
 \f[B]\f[CB]Esc\f[B]\f[R]
-In entry details view, go back to browser
+Focus or go back to browser (from entry details or search)
 .TP
 \f[B]\f[CB]Tab, Shift-Tab\f[B]\f[R]
-Cycle focus between elements (eg: list and search bar; login fields;
-exit dialog)
+Cycle focus between elements in login fields and exit dialog
 .TP
 \f[B]\f[CB]Enter\f[B]\f[R]
 Show entry details of selected entry.
@@ -120,7 +119,7 @@ Esc
 T}@T{
 Clear command
 T}@T{
-Quit
+Focus Browser
 T}@T{
 Back
 T}@T{
@@ -129,11 +128,24 @@ T}@T{
 -
 T}
 T{
-Tab
+/
 T}@T{
 Focus Search
 T}@T{
-Focus Browser
+-
+T}@T{
+-
+T}@T{
+-
+T}@T{
+-
+T}
+T{
+Tab
+T}@T{
+-
+T}@T{
+-
 T}@T{
 -
 T}@T{
@@ -240,17 +252,18 @@ T}
 \[ga]YOUR_PASSWORD\[ga] (Assuming database path stored in config and no
 keyfile)
 .IP "3." 3
-(Focus is on search bar by default) \[ga]git\[ga] (List filtered to
-items with \[lq]git\[rq] in title)
+\[ga]/\[ga] (Focus search bar)
 .IP "4." 3
-\[ga]Tab\[ga] (Focus to list)
+\[ga]git\[ga] (Filter list to items with \[lq]git\[rq] in title)
 .IP "5." 3
-\[ga]j\[ga] (Focus one entry below)
+\[ga]Esc\[ga] (Focus to list)
 .IP "6." 3
-\[ga]p\[ga] (Copy password)
+\[ga]j\[ga] (Focus one entry below)
 .IP "7." 3
-\[ga]Esc\[ga] (quit)
+\[ga]p\[ga] (Copy password)
 .IP "8." 3
+\[ga]Esc\[ga] (quit)
+.IP "9." 3
 (Focus is on clear clipboard and exit by default) \[ga]Enter\[ga] (clear
 clipboard and exit)
 .SH CONFIGURATION

docs/out/kpxhs.1.md

@@ -1,4 +1,4 @@
-% kpxhs(1) Version 1.8 | kpxhs manual
+% kpxhs(1) Version 1.9 | kpxhs manual
 
 # NAME
 
@@ -32,10 +32,10 @@ Interactive [Keepass](https://keepass.info/) database TUI viewer. The database a
 : Go up a directory, or attempt to quit if in root directory.
 
 `Esc`
-: In entry details view, go back to browser
+: Focus or go back to browser (from entry details or search)
 
 `Tab, Shift-Tab`
-: Cycle focus between elements (eg: list and search bar; login fields; exit dialog)
+: Cycle focus between elements in login fields and exit dialog
 
 `Enter`
 : Show entry details of selected entry. Attempts login if locked
@@ -63,8 +63,9 @@ The following table shows a summary of the keybindings and their effects in each
 |Key  | Browser           | Search       | Entry details| Login      | Exit dialog
 |-----|-------------------|--------------|--------------|------------|------------
 |q    | Go up dir or quit | -            | -            | -          | -
-|Esc  | Clear command     | Quit         | Back         | Quit       | -
-|Tab  | Focus Search      | Focus Browser| -            | Cycle Focus| Cycle Focus
+|Esc  | Clear command     | Focus Browser| Back         | Quit       | -
+|/    | Focus Search      | -            | -            | -          | -
+|Tab  | -                 | -            | -            | Cycle Focus| Cycle Focus
 |Enter| Show details      | -            | -            | Unlock     | -
 |j    | Move down         | -            | -            | -          | -
 |k    | Move up           | -            | -            | -          | -
@@ -78,12 +79,13 @@ The following table shows a summary of the keybindings and their effects in each
 
 1. \`kpxhs\`
 2. \`YOUR_PASSWORD<Enter>\` (Assuming database path stored in config and no keyfile)
-3. (Focus is on search bar by default) \`git\` (List filtered to items with "git" in title)
-4. \`Tab\` (Focus to list)
-5. \`j\` (Focus one entry below)
-6. \`p\` (Copy password)
-7. \`Esc\` (quit)
-8. (Focus is on clear clipboard and exit by default) \`Enter\` (clear clipboard and exit)
+3. \`/\` (Focus search bar)
+4. \`git\` (Filter list to items with "git" in title)
+5. \`Esc\` (Focus to list)
+6. \`j\` (Focus one entry below)
+7. \`p\` (Copy password)
+8. \`Esc\` (quit)
+9. (Focus is on clear clipboard and exit by default) \`Enter\` (clear clipboard and exit)
 
 # CONFIGURATION