Add in-app links to the online manual - #409
Merged
Merged
Conversation
Add a Help button to the left sidebar that opens the online manual in the browser, plus a contextual "Open Manual" link in the RX ANSI Escape Codes settings section deep-linked to the ANSI codes reference. Reuses the existing shell.openExternal pattern from the Graphing pane.
✅ Deploy Preview for ninjaterm-docs canceled.
|
✅ Deploy Preview for ninjaterm-app canceled.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A first step toward integrating help into the app (someone asked about this). Rather than embedding the manual, this adds in-app entry points to the existing online manual — the lightweight option.
HelpOutlineIcon), pinned to the bottom (marginTop: auto) so it sits apart from the pane-switching buttons, since it opens externally rather than switching panes. Opensninjaterm.mbedded.ninja/manual.…/manual#ansi-escape-codes— pairs with the recent "Show Unknown Escape Codes" feature.Both reuse the existing
window.electronAPI.shell.openExternalpattern already used by the Graphing pane's "Open Manual" button — no new plumbing.Notes
This is the minimal "more links" approach. Fuller in-app help (rendering the bundled manual markdown natively in a Help pane, working offline) was considered but deferred. Natural follow-up spots for more contextual links: other settings sections and an About entry.
Testing
npx tsccleannpm run test:unit— 254 tests pass (UI-only change; no unit-test coverage for these views)