docs: fix README typos, broken example, and duplicated section#158
Open
Tarunswamy-Muralidharan wants to merge 1 commit into
Open
docs: fix README typos, broken example, and duplicated section#158Tarunswamy-Muralidharan wants to merge 1 commit into
Tarunswamy-Muralidharan wants to merge 1 commit into
Conversation
Fixes zigcBenx#114 Changes: - Fix 'Preresequisits' -> 'Prerequisites' - Fix 'recomended' -> 'recommended' - Fix 'configs.ini' -> 'config.ini' - Fix 'If no of steps' -> 'If none of the steps' - Fix 'achive' -> 'achieve' - Fix 'Recieving' -> 'Receiving' - Fix en-dash in '--auto_merge' example to double hyphen - Add missing '--no_iteration' flag documentation - Add 'pip install -r requirements.txt' as primary install path - Remove duplicated 'Last production deployment' section
Author
|
Hi @zigcBenx — this is a focused, surgical fix that addresses all the README issues without rewriting the entire document:
Unlike the earlier PRs that proposed larger rewrites, this change is minimal and review-friendly. Hope it helps! |
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.
Fixes #114
This is a focused, surgical fix for the documentation issues that keeps the existing README structure intact while correcting all known errors:
Fixes
gh review --auto_mergeto proper double hyphen (--) — copy-pasting the old example would fail--no_iterationto the excluding-features listpip install -r requirements.txtas the primary install pathWhy this approach
Instead of restructuring the entire README, this PR preserves the existing style and fixes the specific bugs. Smaller diffs are easier to review and less likely to introduce new issues.
Verification
git diff --checkpassesnpx --yes markdownlint-cli --disable MD013 MD033 MD041 -- README.mdpasses