docs: documentation pass across README, runbooks, and rustdoc#59
Merged
Conversation
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The "Known gaps" section had drifted to track features that had since shipped. Rename to "Resolved items" and drop the status glyphs; the entries stay as a changelog of what landed when. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Rephrase prose comments and clap --help text for clarity. Drop a few internal spec/PR references from user-facing CLI help and the probe crate's crates.io blurb; internal module-doc references are retained. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Summary
--helptext across the workspace. Drops a few internal spec/PR references from user-facing CLI help and the probe crate's crates.io description; module-internal references are kept.Test plan
packetframe --helpand each subcommand--helprender cleanly with no internal-doc artifacts🤖 Generated with Claude Code