Repository navigation
docs/ documented commands and files that do not exist - #101
Merged
Merged
Conversation
Same documenting-fiction defect the top-level README carried before its rewrite,
in the supporting docs:
docs/TOOL_REFERENCE.md headed v10.0.0, described `netreaper session`,
`netreaper crack`, `netreaper install`, `netreaper
help` and --quick/--monitor flags, none real.
docs/README.md indexed NETREAPER-GIT-HOWTO.md and
NETREAPER-FORGOTTEN-FEATURES.md, never in the folder.
ENVIRONMENT_VARIABLES.md,
SUPPORT.md "see also" links to QUICKREF/HOWTO/TROUBLESHOOTING,
also absent.
Command examples now match the real CLI (scan --type, wifi monitor/crack, web
auto, ble plan, can dump), the indexes and see-also links resolve, and the
top-level README is named as the authoritative command reference so these do not
drift into a second source of truth again.
test_docs_reference_real_commands.py guards it: a `netreaper <word>` in any
docs/*.md must be a registered command, and a sibling-doc link must resolve. It
found the dead links above, and its first run also caught my own caveat text
naming the fake commands in `netreaper <cmd>` form -- reworded so the counter-
examples do not read as real.
1033 passed; bats 39/39; ruff clean. 12.1.6 -> 12.1.7.
Stacked on #100 (fix/export-audit-log-query); merge that first.
Nerds489
force-pushed
the
fix/stale-docs
branch
from
September 25, 2026 14:48
054aa91 to
82aff93
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Discretionary doc cleanup (the substantive tracker is clear). Same
documenting-fiction defect the top-level README carried before its rewrite, now
in the supporting docs.
What was wrong
docs/TOOL_REFERENCE.mdnetreaper session/crack/install/help+--quick/--monitor, none realdocs/README.mdNETREAPER-GIT-HOWTO.md,NETREAPER-FORGOTTEN-FEATURES.md, never in the folderENVIRONMENT_VARIABLES.md,SUPPORT.mdQUICKREF/HOWTO/TROUBLESHOOTING, absentFix
Command examples now match the real CLI; indexes and see-also links resolve; the
top-level README is named as the authoritative command reference so the docs do
not drift into a competing source of truth again.
Guard
test_docs_reference_real_commands.py: anetreaper <word>in anydocs/*.mdmust be a registered command, and a sibling-doc Markdown link must resolve. It
found the dead links in
ENVIRONMENT_VARIABLES.md/SUPPORT.mdI would not havespotted by hand, and its first run caught my own caveat text writing the fake
commands in
netreaper <cmd>form (reworded).1033 passed; bats 39/39; ruff clean. 12.1.6 -> 12.1.7.