Help

# Help — Documentation Browser Four tabs: Manual (language manual), Reference (per-symbol API docs), Apps (help shipped by each app package) and Contextual (docs for the keyword/symbol under the editor cursor). Open an app's help explicitly with the panel-name palette's Help action (top-left of the app's title bar); it opens on the Apps tab with that app selected. Focusing an app no longer switches this panel automatically. App help lives inside each app package under `help/` (`help/help.md` is the main page, other `.md` files are extra docs). The Apps index is discovered by scanning the configured package roots, so newly installed apps with a `help/` directory show up automatically. ## Key Bindings | Key | Action | |-----|--------| | `Up` | Scroll content up | | `Down` | Scroll content down | | `Page Up` | Scroll up by 10 lines | | `Page Down` | Scroll down by 10 lines | | `Home` | Scroll to top of document | | `End` | Scroll to bottom of document | | `Ctrl+P` | Toggle pin — when pinned, help stays on the current topic and ignores focus/cursor changes | | `Ctrl+Page Up` / `Ctrl+Page Down` | Switch tabs (Manual / Reference / Apps / Contextual) | | `/` | Open the in-document search box at the bottom of the panel | | `Ctrl+Shift+/` | Open the find panel in a horizontal split, searching `*.md` docs for the selected word (double-click), else the in-document query, else the contextual symbol | | `i` | Open the active tab's index dialog (Manual / Reference / Apps) | ### In-document search (`/`) `/` opens a search box on the bottom row and searches the document in the active tab as you type. Matches are highlighted one line at a time and the viewer scrolls to the current match. | Key | Action | |-----|--------| | `Enter` | Jump to the next match | | `Shift+Enter` | Jump to the previous match | | `Left` / `Right` / `Home` / `End` | Move the query cursor | | `Backspace` / `Delete` | Edit the query | | `Escape` | Close the search box and clear the highlight | ### Mouse | Action | Behavior | |--------|----------| | Mouse scroll | Scroll content | | Click a line | Select the line (Ctrl+Enter evals it, Ctrl+C copies it) | | Double-click a word | Select that word — `Ctrl+Shift+/` searches it, `Ctrl+C` copies it | | Click index header | Open the active tab's index dialog | | Ctrl+click link | Follow a doc link, or open a source-file link in the editor | ## Features - Manual, Reference and Apps tabs, each with an incremental-search index dialog (`i`) - Apps tab scans packages for `help/` directories and renders each app's docs - Contextual help follows the editor cursor automatically - Pin to lock the current help content (Ctrl+P) - In-document search with match navigation (`/`) - Full-text Search/Apropos over the manual, reference and app corpora - Edit help files directly from the panel menu ## Pie Menu Hold the pie trigger (Super by default; `[config/set "ui/pie-trigger" :f1]` to change it) with the help panel focused, hover the hub to descend, then release on a slice: | Dir | Slice | Key | Action | |-----|-------|-----|--------| | N | Pin / Unpin | `p` | toggle pin (label follows the pinned state) | | NE | Next Page | `f` | history forward | | E | Reference | `r` | Reference tab | | SE | Apps | `a` | Apps tab | | S | Contextual | `c` | Contextual tab | | W | Manual | `m` | Manual tab | | NW | Prev Page | `b` | history back |