Repository navigation
docs(readme): outcome-first hero section, plus "don't just" detection - #5
Merged
Merged
Conversation
The not-just rule only matched the literal word "not", so "leaders don't just manage teams, but inspire them" slipped through. Match n't contractions, and add the comma form where a pronoun replaces "but".
Replace the mechanism-first intro with a one-line promise, the install commands, a flagged before paragraph, and a rewrite. The after text is a placeholder until it is swapped for real /scribe:revise output.
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.
Why
The README opened by describing the pipeline. Visitors decide in seconds, so the top now leads with what Scribe does for a writer, how to install it, and a before/after demo.
While building the demo, the detector missed "don't just manage teams, but inspire them," so that's fixed here too.
What changed
not_just_butnow matchesn't justcontractions. A newdont_just_comma_claimkind catches "don't just X, they Y." Three new positive tests are added.Before merging
/scribe:reviseoutput and its sameness score, so the demo shows Scribe's actual output.Verification
python3 -m unittest discover -s testspassespython3 tools/validate_plugin.pypasses