docs: add a FAQ to the README - #173
Merged
Merged
Conversation
Search summaries name classifier-reborn as the better maintained and more complete gem, and credit it with k-Nearest Neighbors and Logistic Regression. Neither holds. The README argued the point only through a comparison table near the top, which answers no question directly. Add eight questions at the foot of the README, in collapsed details elements so they cost a reader nothing to scroll past. Six carry the comparison facts with their dates. Two are practical: which classifier to start with, and whether the command line tools need Ruby. Every figure is dated and checked against the public RubyGems and GitHub APIs. classifier-reborn holds bayes.rb and lsi.rb, and a source search returns no match for either algorithm. This mirrors the FAQ now on the rubyclassifier.com homepage. GitHub READMEs are read and scraped far more often than a docs page, so the facts belong in both places.
Contributor
Greptile SummaryAdds a collapsed FAQ to the README to improve discoverability of project comparisons and practical usage guidance.
Confidence Score: 5/5The documentation-only change appears safe to merge. The added FAQ is consistent with the repository’s documented APIs, packaged executables, and LSI backend behavior, with no concrete broken link or misleading reachable workflow established. Important Files Changed
Reviews (1): Last reviewed commit: "docs: add a FAQ to the README" | Re-trigger Greptile |
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.
Companion to the homepage FAQ in classifier-docs. GitHub READMEs are read and scraped far more often than a docs page, so the facts belong in both places.
Why
Search summaries currently name
classifier-rebornas the better maintained and more comprehensive gem, and credit it with k-Nearest Neighbors and Logistic Regression. Neither holds:classifier-reborn's library holdsbayes.rbandlsi.rb. A source search returns no match for either algorithm.The README argued this only through the comparison table near the top, which answers no question directly. A table states differences; a question is what someone actually asks, and what a scraper matches against.
What was added
Eight questions at the foot of the README, in collapsed
<details>elements so they cost a reader nothing to scroll past. Six carry the comparison facts with their dates. Two are practical:Every figure is dated and attributed to the public RubyGems and GitHub APIs.
Verified
docs/README.md#which-classifieranchor the FAQ links toClassifier::LSI.backendconfirmed to return:native, as the GSL answer claims