Fix README typos and remove duplicated section#143
Open
trandaiviethung2001 wants to merge 1 commit into
Open
Conversation
Documentation fixes spotted in README.md: - Typos: Preresequisits → Prerequisites, recomended → recommended, achive → achieve, Recieving → Receiving. - "configs.ini" → "configs/config.ini" (the actual filename). - "If no of steps above happen" → "If none of the steps above happen". - En-dash in `gh review –-auto_merge` replaced with proper `--`. - "Gitlab" → "GitLab" in user-facing prose. - Removed the empty "## Getting started 🚀" header that had no content. - Removed a verbatim duplicate of the entire "Last production deployment" section that appeared twice in a row. No content changes — only typo, casing, punctuation and de-duplication fixes to the README. Refs zigcBenx#114
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.
Summary
Pass over
README.mdto address the docs issues flagged in #114. No content changes — only typo, casing, punctuation and de-duplication fixes.Changes
Typos
Preresequisits→Prerequisitesrecomended→recommendedachive→achieveRecieving→ReceivingWrong filename / wording
In configs.ini→In configs/config.ini(the actual filename created in the setup step right above)If no of steps above happen, program will prompt you with question about project_id→If none of the steps above happen, the program will prompt you with a question about \project_id``Punctuation / casing
gh review –-auto_mergeused an en-dash (–) instead of--, so a copy-paste would fail. Nowgh review --auto_merge.Gitlab→GitLabin user-facing prose (matches GitLab's own brand casing and is consistent with the rest of the README).Structure
## Getting started 🚀heading that had no content under it.Diff size
1 file changed, 9 insertions, 42 deletions — most of the line count is the duplicated section being removed.
Test plan
git diffreviewed locally — only README touched, only doc text changedRefs #114
🤖 Generated with Claude Code