docs: consolidate per-tool docs into one root README - #18
Merged
Conversation
Folds docs/*.md into README.md as a section per tool, replacing the
original one-line stubs most of them were with real usage documentation
reflecting current behavior: netcat's actual flags and examples (from its
own argparse epilog), tcp-proxy's positional-argv usage, the SSH tools'
current hardcoded defaults and known limitations (ssh-server.py's fixed
bind address, the required test_rsa.key), etc. packet-sniffer's own docs
(already thorough) are preserved, trimming only the now-inapplicable
standalone-PyPI-package installation/TestPyPI instructions superseded by
the toolkit's own single `pip install -e ".[dev]"` path.
docs/ is removed now that the README is the single source of truth, per
CLAUDE.md's target state ("One clean root README... per-tool docs folded
into a section each"). Added a "Tools" table of contents linking to each
new section; verified every anchor link against GitHub's heading-to-anchor
conversion rules.
Verified: no remaining references to the removed docs/*.md paths anywhere
in the repo; full pytest suite (179 tests), ruff, and mypy all unaffected
and still clean (a docs-only change).
Part of #6
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
✅ AgentGate: Passed12 files changed · +155 -269 lines No issues found. Generated by AgentGate |
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
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.
Summary
Second of two PRs for Phase 5 (v0.5.0 — CI & docs, part of #6). Folds
docs/*.mdintoREADME.mdasone section per tool, per CLAUDE.md's target state ("One clean root README... per-tool docs folded
into a section each").
Most of the original
docs/*.mdfiles were one-line stubs (e.g.tcp-client.md: "Basic Python TCPclient") left over from the original raw-repo merge — rather than just copy-pasting those into the
README, I wrote real usage documentation reflecting current behavior: netcat's actual flags/examples
(pulled from its own
argparseepilog),tcp-proxy's positional-argv usage, the SSH tools' currenthardcoded defaults and known limitations (
ssh-server.py's fixed bind address, the requiredtest_rsa.key), etc.packet-sniffer's own docs (already thorough) are preserved, trimming only thenow-inapplicable standalone-PyPI-package installation/TestPyPI instructions — superseded by the
toolkit's own single
pip install -e ".[dev]"path.docs/is removed now that the README is the single source of truth. Added a "Tools" table ofcontents at the top linking to each section.
Test plan
conversion rules (lowercase, strip backticks/parens, spaces → hyphens)
grep'd the whole repo for any remaining reference to the removeddocs/*.mdpaths — none foundpytestsuite (179 tests),ruff, andmypyall unaffected and still clean (a docs-onlychange)
🤖 Generated with Claude Code