Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Update information seen in the "Help" dialog

Open
#232 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale

Research direction

No file, test, or entry point is named. Start by locating the Help dialog and reviewing its existing icon explanations, keyboard shortcuts, and video tutorials; done means the dialog presents up-to-date help in an agreed format.

Written by the indexing model from the issue text.

Description

Clicking the "?" icon in the app header opens up a dialog which explains various aspects of the system:

Image

Currently this includes an explanation of the icon buttons in the spectrogram viewer, keyboard shortcuts, and some video tutorials about how to perform certain tasks like uploading files, using the spectrogram viewer, and adding annotations.

The videos still have useful information in them, since the main UI workflows haven't changed all that much, but we should consider presenting the same information using a more up to date version of the application.

I'm not sure if videos or text + images would be the best way to present this information to the end user (it might end up being both, maybe a quick video tutorial that shows upload + annotating, and some written out explanation of other features that can act as a quick reference).

Dominant language
Python
Stars
10
Forks
3
Avg merge
5d 13h
Merged PRs (30d)
2

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

  • Ships a Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Kitware/batai

All issues in Kitware/batai

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.