nmap / nmap/npcap

Improve Npcap installer options documentation

Open
#66 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

current documentation
Dominant language
C
Stars
3.6k
Forks
592
PR merge metrics
No merged PRs in 30d

Description

The Npcap User's Guide is awesome (IMHO), but it would be great to improve the installer option section. In particular, it would be nice to have a short section on each option which describes in more detail what it does. Right now there is just a one sentence description for each, but many of the options like /admin_only are more complex. Another thing we should cover is Npcap installer return codes, which is especially important for /S users.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with the Npcap User's Guide installer option section linked in the issue and review the existing one-sentence descriptions. Done means each installer option has a more detailed explanation and the guide documents installer return codes, including behavior relevant to /S users.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.