Repository navigation
docs(readme): align with the repository standard - #17
Merged
Merged
Conversation
Rename Sign in to Quick start, drop hard-coded plugin versions from Troubleshooting, and trim below the 1200-word limit.
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.
Problem: the README used a
Sign insection instead of the STANDARDQuick startslot, hard-coded plugin versions in Troubleshooting, and was 1350 words (over the 1200 limit).Change: renamed
Sign intoQuick start, reworded the stale-version Troubleshooting bullet without version numbers, and trimmed to 1199 words with all facts and relative links intact. H1 keeps the repo slug per the sibling plugin family convention.Verification: no README assertions in tests/ or src/;
npm testpasses locally (43/43); word count by whitespace split is 1199; all 8 relative links resolve.