Help & Docs Panel (in-app docs site)
A built-in help browser that loads the public Omniscio documentation inside the app, with back, forward, home and an open-in-browser escape hatch — so you can read the docs beside your sessions instead of switching to Chrome.
On this page
What it is
A built-in help browser that loads the public Omniscio documentation site (https://docs.omniscio.com) inside an Electron <webview> without leaving the app. It's a full mini-browser — back / forward / home buttons, a title bar that mirrors the current section heading, and an Open in browser escape hatch — so you can read docs alongside your sessions instead of context-switching to Chrome. Originally external links in Omniscio kicked you to your default browser; the panel keeps reading flow inside Omniscio for everything documented on the help site.
The panel is also the destination of every "?" / Help affordance in the toolbar and is the surface that other Omniscio features deep-link to when they want to show feature-specific docs (e.g. an empty state's "Learn more" link).
Where to find it
How to use it
- Open it. Three entry points, all equivalent:
- Toolbar Help icon — the
?(HelpCircle) button in the toolbar's overflow row labeled Help & Docs. - Keyboard shortcut —
Ctrl+Shift+/(rebindable at Settings → Keyboard Shortcuts → "Open Help"). - Programmatic — other features fire the
open-help-panelwindow event to toggle it on.
- Toolbar Help icon — the
- Read. The webview loads the Omniscio docs site. The current page's heading shows in the panel's title bar (read from the loaded page's
main h1). The loading indicator is a thin accent bar across the top of the body while pages fetch. - Navigate. Standard browser nav inside the embedded page works as you'd expect — click any link, use the back ⟵ and forward ⟶ arrows in the panel header, or click the home icon to jump back to the docs landing page. The back/forward arrows are disabled when there's no history in that direction.
- Watch the tutorial videos. Click ▶ Videos in the header to jump straight to the Tutorial Videos page (
/tutorial-videos.htmlon the docs site — the one anchor that leaves the generated library, resolved through the same legacy-anchor map the section deep links use) — every onboarding video, rewatchable any time (see tutorial-videos.md). On a phone / Web Access, where the panel has no embedded browser, the Watch tutorial videos button opens that page in your browser. - Open in your real browser. Click Browser in the header (link-out icon) to open the page you're viewing in your OS default browser — useful for sharing a docs URL, opening multiple help tabs, or using the browser's find-in-page if you need more than what the webview offers.
- External links handled cleanly. If a link inside the docs site points to an external host (GitHub, external tools, etc.), Omniscio denies the popup and opens it via your OS default browser instead of spawning a separate webview window. The help panel itself stays on the docs site.
- Close. Click the × in the panel header, or press
Ctrl+Shift+/again to toggle back to the dashboard.
How it behaves
How it works
Component. A single React component at HelpPanel.tsx wraps an Electron <webview> tag and a 44px (h-11) header bar with the back / forward / home / Browser / close buttons. The webview's src is the docs library home by default, or — when a section was deep-linked — the library page that section id resolves to through libraryPathForLegacySection (legacy-anchor-map.ts); it is never a #<section> hash. The docs base is NOT a pinned literal — it is docsSiteUrl / DOCS_SITE_BASE, the shared single source (download-url.ts, defaulting to DEFAULT_DOCS_SITE_BASE = 'https://docs.omniscio.com' in docs-site-base.ts, repointable per-seam via RENDERER_VITE_HELP_SITE_URL). Read the constant, never hard-code the host.
Lifecycle wiring. App.tsx lazy-loads the panel (React.lazy()) so the docs webview infrastructure isn't paid for until you actually open it. App.tsx tracks currentView === 'help' and toggles to/from 'dashboard' when the open-help-panel window event fires. The keyboard handler at useKeyboardShortcuts.ts dispatches that event for the openHelp action, defined at keybindings.ts with default Ctrl+Shift+/.
Title sync. Whenever the embedded page finishes loading (did-stop-loading), Omniscio runs document.querySelector('main h1')?.textContent || 'Help' inside the webview via executeJavaScript and writes the result into the panel's title bar. Every library page the panel serves carries a <main> heading — the index (<main class="lib-page" id="content"> with its <h1>) and a content page (<main> containing <article class="lib-article"> with its <h1>) — so the title reflects the page you're reading rather than the page's HTML <title>.
Deep-linking from other features. Features elsewhere in Omniscio fire open-help-panel with { ensureOpen: true, section }. If the panel is already mounted, its window.__helpPanelNavigate handle (registered while mounted, removed on unmount) resolves the section id through libraryPathForLegacySection (legacy-anchor-map.ts) and loads that library page — never a #<section> hash on the root, which would spend a redirect hop and break before the site's JS had loaded. If the panel is NOT mounted yet, the section is staged in help-panel-pending-section.ts (a one-shot read-and-clear handoff) and consumed at mount into the webview's initial library-page URL, so the deep link never races the panel or the site load. Only section ids that actually exist on the docs site are deep-linked — the id set is HELP_SITE_SECTION_IDS (help-site-section-ids.ts, held in step with the map's keys by a guard test) — and an id with no covering library page resolves to the library home (LIBRARY_HOME_PATH) rather than a 404.
Webview enablement requirement. Embedding any <webview> tag requires webPreferences.webviewTag: true on the BrowserWindow, which in turn forces sandbox: false. This is a known and accepted security trade-off (also needed by RepoGuard, the email viewer, and other plugin UIs). It is recorded as accepted debt L10-F01 in g8-electron-sandbox-plugin-trust-postmortem.md, and the compensating control is documented in electron-fuses-contract.md — the main window cannot be sandboxed, so Electron fuses are the available defense-in-depth. Windows that do NOT host a webview stay fully sandboxed (the detached-session window, the OAuth popup); see ai-browser-contract.md popout-posture for the per-window rule.
External link routing. A popup is denied in MAIN, not by a renderer listener — setWindowOpenHandler in webcontents-hardening.ts runs on every webContents (an attached <webview> included), and for an http/https target it opens the URL through shell.openExternal() after URL validation; a non-http(s) target is blocked with a warning. Inside-the-docs-site links navigate within the webview as normal.
No content cached locally. The panel always fetches from docs.omniscio.com — pages are NOT bundled into Omniscio's installer. This means the docs can ship incrementally (deploy docs/help-site/ with npm run docs:deploy, which syncs the library/roadmap/features/legal mirrors first and THEN runs the firebase deploy — never the raw firebase command on its own) without an Omniscio release. The trade-off is that the panel needs internet to load; offline users see Chromium's standard "no internet" page inside the webview.
Related
- keyboard-shortcuts.md — shortcut catalog including
openHelp(Ctrl+Shift+/) - tutorial-videos.md — the Tutorial Videos library the Videos button opens
- training-hub.md — the in-app Training Hub: the same videos playing in the app, an offline docs reader, and a link back to this panel
- INDEX.md — this LLM library is a separate doc surface from the help site; the LLM library targets agents, the help site targets humans
Last verified 2026-10-10