Skip to content

Conversation

@VNel
Copy link

@VNel VNel commented Dec 24, 2025

This pull request adds a short "Quick Start" section to the README.

While the README already points users to man htop and the built-in help for a complete list of commands, it currently does not provide a short, immediately visible overview of commonly used actions.

The new section is intended to improve onboarding for new users by highlighting a few frequent default actions (e.g. searching, sorting, tree view, killing a process), while explicitly referring to man htop as the primary and complete documentation source.

No functional changes are introduced.

Definition of Done (DoD):

  • A new "Quick Start" section exists in the README
  • The section lists only common default actions and key bindings
  • Existing documentation remains unchanged
  • No functional or behavioral changes to htop
  • man htop remains the primary reference for full documentation

Related issue: #1840

Added a Quick Start section with commonly used actions for htop.
@BenBE BenBE linked an issue Dec 24, 2025 that may be closed by this pull request
@BenBE BenBE added documentation 📖 Improvements or additions to documentation needs-discussion 🤔 Changes need to be discussed and require consent labels Dec 24, 2025
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 needs-discussion 🤔 Changes need to be discussed and require consent

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a short "Quick Start" section to the README for common actions

2 participants