docs: comprehensive documentation update (v2.4+)#83
Merged
Conversation
- readme.md: rewrite to reflect v2.4+ features - dynamic timeout adaptation (RTT EWMA) - multi-NIC parallel sending via --interface - streaming SDK (EnumStream/VerifyStream) - updated flag names (--bandwidth, --interface, --wildcard-filter, --format) - test commands and regression test instructions - all examples updated - README_EN.md: full English rewrite matching readme.md - accurate flag reference (--interface replaces --eth, -s alias for --silent) - multi-NIC and dynamic timeout documented - platform notes updated - sdk/README.md: rewrite to match actual SDK API - Devices []string field for multi-NIC documented - EnumStream/VerifyStream callback signatures - ExtraWriters custom sink example - sentinel errors table - docs/quickstart.md: add device/test commands, go install, multi-NIC example - docs/api.md: add Devices field to Config type - docs/best-practices.md: add multi-NIC section, dynamic timeout section - docs/faq.md: add multi-NIC FAQ, flag rename reference table - docs/OUTPUT_FORMATS.md: update --oy to --format (preferred) with legacy alias note
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
Full documentation refresh to accurately reflect the current codebase state.
Files updated
readme.mdREADME_EN.mdsdk/README.mdDevices []string,EnumStream/VerifyStream,ExtraWriters, error tabledocs/quickstart.mddevice/testcommands,go install, multi-NIC exampledocs/api.mdDevicesfield toConfigtypedocs/best-practices.mddocs/faq.mddocs/OUTPUT_FORMATS.md--formatpreferred over legacy--oyKey additions
--timeoutis adaptive (RFC 6298 EWMA), no manual tuning needed--interfacerepeatable;Config.Devices []stringin SDKEnumStream/VerifyStreamcallback API documented with goroutine-safety note--bandwidth,--interface,--wildcard-filter,--format,-salias for--silentErrPermissionDenied,ErrDeviceNotFound,ErrDeviceNotActive,ErrPcapInitdocumentedNo code changes — documentation only.