Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[documentation] Add documentation from v0.3.6 onwards #40

Closed
darkhz opened this issue Mar 8, 2024 · 0 comments
Closed

[documentation] Add documentation from v0.3.6 onwards #40

darkhz opened this issue Mar 8, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@darkhz
Copy link
Owner

darkhz commented Mar 8, 2024

Since v0.3.6, changes have not been documented and features must be added with screenshots, gifs and descriptions.
Contributions/PRs will be reviewed before merging.

Follow the format according to how the previous documentation has been added.
Each new feature must have its own separate page.

The following features must be documented:

Queue

  • Recommendations tab
  • Audio/Video switching
  • Shuffle mode

Media Fetcher

  • Opening the fetcher
  • Reload, Cancel each/all loading media items
  • Clearing the fetcher

Custom Seeker

  • Opening the seek dialog
  • Navigate between inputs
  • Seek by relative/absolute positions

Theming

  • Open the theme selector
  • Applying a theme

A brief documentation is here: https://github.com/darkhz/invidtui/tree/theme

Channel

  • Releases tab

Keybindings

New keybindings must be added within the keybindings table for:

  • Queue
  • Fetcher
  • Custom Seeker
  • Theme Selector

New keybinding names:

  • KeySelect -> Enter

New defaults:

  • KeyLoadMore -> .

Certain keybinding names have changed:

  • KeySwitchTab to KeySwitch
@darkhz darkhz added the documentation Improvements or additions to documentation label Mar 8, 2024
@darkhz darkhz pinned this issue Mar 8, 2024
@darkhz darkhz added the good first issue Good for newcomers label Mar 8, 2024
@darkhz darkhz self-assigned this Mar 9, 2024
@darkhz darkhz closed this as completed Mar 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant