docs: drop the duplicated feature list from the README - #90
Merged
Conversation
The "What's inside" section listed the library's capabilities and the GUI app's, both of which the Documentation table right below it already points at — searching, pattern scan, pointers, pointer scan, the app, the API reference. Two lists of the same thing drift apart, and the one that goes stale is the one nobody edits when a feature lands. The README keeps what only it can do: what the project is, how to install it, and a three-line example.
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.
Why is this PR necessary, what does it do?
Removes the "What's inside" section from the README.
It listed the library's capabilities and the GUI app's, and the Documentation
table immediately below it already points at every one of them — searching,
pattern scan, pointers, pointer scan, the app, the API reference. Two lists of
the same thing drift apart, and the one that goes stale is the one nobody
remembers to edit when a feature lands.
The README keeps what only it can do: what the project is, how to install it,
and the three-line example.
Checklist (complete all items):
References:
No references to be shared.
Notes:
Nothing links to the removed section — no
#whats-insideanchor anywhere inREADME.md,docs/or.github/. (docs/app.mdhas a heading with the samename, but it is that file's own section and is not referenced from outside it.)
The surrounding text still reads continuously: example → "That's it — read,
write or scan another process in three lines" → Documentation.