Skip to content

Feature request: Controls and Help buttons open external docs instead of showing help in the GUI #1040

Description

@NileshArnaiya

Describe the issue:

Environment

  • OS: macOS 15.7.4 (aware macOS isn't fully supported)
  • kilosort: v4.1.3

Current behavior

Clicking "Controls" or "Help" in the main window opens
https://kilosort.readthedocs.io/en/latest/gui_guide.html in a browser.

Why this is a problem

  • Breaks flow: you leave the app to learn how to use the app

Proposal

Replace both with an in-app modal:

  • Controls -> keyboard/mouse shortcut table, generated from the same source
    as the docs so it can't drift
  • Help -> short panel for the current context, with a "full docs" link out

Happy to implement this. Two questions before I start:

  1. Modal dialog, or dockable side panel?
  2. Would you accept the shortcut table being generated from a single dict
    in the codebase that the sphinx docs also read from?

PS: This is mainly a UI/UX enhancement.

Reproduce the bug:

Error message:

Version information:

Environment

  • OS: macOS 15.7.4 (aware macOS isn't fully supported)
  • kilosort: v4.1.3
  • python: 3.11.15

Activity

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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions