docs: sharpen README positioning and structure - #43
Merged
Conversation
0x0bug
marked this pull request as ready for review
August 6, 2026 01:56
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.
What changed
Why WDTtable, clearer quick start, screenshots, report lifecycle, requirements, limitations, and support paths;.\WindowsDiagnosticsReports, while command-line mode uses the current working directory;-NoExternalNetworkTestsopt-out;v0.1.0-betarather than using a temporal “latest” label;docs/usage.md;tests/readme.tests.ps1with dependency-free quality checks.Quality contract
The README test now checks:
Why
The previous README was technically thorough but presented low-level behavior before the product value was clear. The audit also found one factual mismatch in the default output directory and several claims that needed narrower wording around process isolation, filesystem writes, and external network probes.
Impact
Documentation and documentation tests only. No production scripts, bootstrap content, module behavior, report format, or release assets changed.
Validation
Latest head:
08e15b24c10df839a845e4c60dc37cf19fb33615.The complete
PowerShell Validationworkflow passed:Additional audit checks:
v0.1.0-betaprerelease and both release assets exist;Not verified from this environment
Live DNS/HTTP reachability of
wdt.digitalcould not be tested because the current execution environment has no external DNS resolution. Repository/API-backed existence and bootstrap synchronization were verified instead.