Skip to content

feat(ui): add contextual help links pointing to docs folder #492

New issue
New issue
Closed
#613
#602
Closed
feat(ui): add contextual help links pointing to docs folder#492
#613
#602
Labels
enhancementNew feature or requestpriority:lowLow priority
Milestone
v1.49.0 - UX & Customization

Description

@Starosdev
Starosdev
opened on May 9, 2026

Summary

Add contextual help links in the UI that point to the relevant documentation in the repository's `docs/` folder.

Why

Users frequently struggle to find documentation for specific features. In-app links reduce friction and improve discoverability without requiring users to search the repository.

Acceptance Criteria

  • Identify key UI sections that benefit from doc links (settings, notifications, SMART thresholds, overrides, etc.)
  • Add help icon/link components that open the relevant docs URL

Activity

  1. Starosdev
    added this to the v1.49.0 - UX & Customization milestone on May 9, 2026
  2. Starosdev
    added
    enhancementNew feature or request
    priority:lowLow priority
    on May 9, 2026
  3. Starosdev
    added 2 commits that reference this issue on Jun 9, 2026

    feat(ui): add contextual help links pointing to docs folder (#492)

    7b484a0

    fix(ui): style learn more link in Consumer Drive Profiles hint (#492)

    ba5b6c3

  4. Starosdev commented on Jun 9, 2026

    @Starosdev
    Starosdev
    on Jun 9, 2026
    OwnerAuthor

    @Starosdev Implementation is on `develop`. Please test via the dev image:

    Docker image: `ghcr.io/starosdev/scrutiny:develop-omnibus`
    Dev instance: http://192.168.1.33:8680

    What to verify

    1. Open Settings dialog
    2. Notification Channels panel — a `help_outline` icon appears in the panel title. Hover shows tooltip "Notification channel documentation". Click opens `TROUBLESHOOTING_NOTIFICATIONS.md` in a new tab. Clicking the icon does NOT expand/collapse the panel.
    3. Consumer Drive Profiles dropdown — hint text ends with a blue underlined "Learn more" link. Click opens `CONSUMER_DRIVE_PROFILES.md` in a new tab.

    Note: CI may still be building the latest image — if you do not see the changes, wait a few minutes and pull again.

  5. Starosdev
    closed this as completedin #602on Jun 11, 2026
  6. Starosdev
    added 4 commits that reference this issue on Jun 11, 2026

    chore(release): 1.63.0

    b233141

    feat(ui): per-URL heartbeat toggle, navigation visibility settings, h…

    1c4628a

    chore(release): 1.64.0

    c845749

    chore(release): 1.65.0-beta.1

    9224eff
  7. quwisky
    added a commit that references this issue on Aug 13, 2026

    feat(ui): navigation visibility, host grouping, contextual help, hear…

    f99c3ff
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestpriority:lowLow priority

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions