Skip to content

docs: consolidate per-tool docs into one root README - #18

Merged
brett-buskirk merged 2 commits into
mainfrom
docs/consolidate-readme
Jul 4, 2026
Merged

docs: consolidate per-tool docs into one root README#18
brett-buskirk merged 2 commits into
mainfrom
docs/consolidate-readme

Conversation

@brett-buskirk

Copy link
Copy Markdown
Owner

Summary

Second of two PRs for Phase 5 (v0.5.0 — CI & docs, part of #6). Folds docs/*.md into README.md as
one 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/*.md files were one-line stubs (e.g. tcp-client.md: "Basic Python TCP
client") 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 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. Added a "Tools" table of
contents at the top linking to each section.

Test plan

  • Verified every table-of-contents anchor link against GitHub's actual heading-to-anchor
    conversion rules (lowercase, strip backticks/parens, spaces → hyphens)
  • grep'd the whole repo for any remaining reference to the removed docs/*.md paths — none found
  • Full pytest suite (179 tests), ruff, and mypy all unaffected and still clean (a docs-only
    change)

🤖 Generated with Claude Code

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>
@brett-buskirk brett-buskirk self-assigned this Jul 4, 2026
…flict

PR #17 (CI gate) merged while this branch was open. Both branches touched
the same v0.5.0 checklist region -- resolved by keeping this branch's
checked "consolidated README" box (this PR is what completes it) alongside
#17's already-checked "CI gate" box.
@github-actions

github-actions Bot commented Jul 4, 2026

Copy link
Copy Markdown

✅ AgentGate: Passed

12 files changed  ·  +155 -269 lines

No issues found.

Generated by AgentGate

@brett-buskirk
brett-buskirk merged commit 33f8fc8 into main Jul 4, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant