Skip to content

docs: fix README typos, broken example, and duplicated section#158

Open
Tarunswamy-Muralidharan wants to merge 1 commit into
zigcBenx:masterfrom
Tarunswamy-Muralidharan:fix-docs-114
Open

docs: fix README typos, broken example, and duplicated section#158
Tarunswamy-Muralidharan wants to merge 1 commit into
zigcBenx:masterfrom
Tarunswamy-Muralidharan:fix-docs-114

Conversation

@Tarunswamy-Muralidharan
Copy link
Copy Markdown

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

  • Typo: 'Preresequisits' → 'Prerequisites'
  • Typo: 'recomended' → 'recommended'
  • Typo: 'configs.ini' → 'config.ini'
  • Typo: 'achive' → 'achieve'
  • Typo: 'Recieving' → 'Receiving'
  • Grammar: 'If no of steps above happen' → 'If none of the steps above happen'
  • Broken example: Fixed en-dash (–-) in gh review --auto_merge to proper double hyphen (--) — copy-pasting the old example would fail
  • Missing docs: Added --no_iteration to the excluding-features list
  • Missing docs: Added pip install -r requirements.txt as the primary install path
  • Duplicated section: Removed the accidentally duplicated 'Last production deployment' block

Why 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 --check passes
  • npx --yes markdownlint-cli --disable MD013 MD033 MD041 -- README.md passes

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
@Tarunswamy-Muralidharan
Copy link
Copy Markdown
Author

Hi @zigcBenx — this is a focused, surgical fix that addresses all the README issues without rewriting the entire document:

  • Fixes 5+ typos (Preresequisits, recomended, configs.ini, achive, Recieving)
  • Fixes the broken gh review --auto_merge example (was using an en-dash instead of double-hyphen)
  • Removes the duplicated "Last production deployment" section (~30 lines)
  • Adds missing --no_iteration flag documentation
  • Keeps the original README style and structure intact

Unlike the earlier PRs that proposed larger rewrites, this change is minimal and review-friendly. Hope it helps!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix docs, Svit

1 participant