Summary
The documentation would benefit from additional example commands and explanations, especially for new users who want to try out the tool quickly. For example, show how to use mvis scan, leak, or TUI commands on both Windows and Linux in README.md, and briefly describe their expected outputs with screenshots or code snippets.
Why
Providing more examples and explanations in the documentation will lower the barrier for new contributors and users, making it easier for them to get started. This is a great onboarding issue for first-time contributors.
Relevant files:
How to approach
- Review the current examples in README.md
- Add at least 1-2 more complete command examples, clarifying which features work on which platform if relevant
- If possible, include small screenshots or code block outputs (can use placeholders)
- Make sure to use clear language, suitable for complete beginners
See CONTRIBUTING.md for guidelines on opening a PR.
Labels: documentation, good first issue
Summary
The documentation would benefit from additional example commands and explanations, especially for new users who want to try out the tool quickly. For example, show how to use
mvis scan,leak, or TUI commands on both Windows and Linux in README.md, and briefly describe their expected outputs with screenshots or code snippets.Why
Providing more examples and explanations in the documentation will lower the barrier for new contributors and users, making it easier for them to get started. This is a great onboarding issue for first-time contributors.
Relevant files:
How to approach
See CONTRIBUTING.md for guidelines on opening a PR.
Labels: documentation, good first issue