Fix README errors, add English translation, and automate sync checking#2
Merged
Conversation
…tency check workflow Co-authored-by: thilob <5732498+thilob@users.noreply.github.com>
Co-authored-by: thilob <5732498+thilob@users.noreply.github.com>
Co-authored-by: thilob <5732498+thilob@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix spelling and textual errors in README.md
Fix README errors, add English translation, and automate sync checking
Jan 24, 2026
Owner
|
@copilot ist der zweite pr bereits fertig? |
Contributor
Author
Ja, dieser PR ist fertig. Alle Anforderungen wurden umgesetzt: ✅ README.md - alle Rechtschreibfehler korrigiert, Skript-Namen vereinheitlicht Der letzte Commit ist cfda637. |
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.
Documentation had German spelling errors, inconsistent script references (
setup_can.shvssetup-can.sh), and lacked an English version. This creates maintenance burden and accessibility issues.Changes
README.md corrections:
setup-can.sh,can-health-check.shREADME.en.md - new file:
Sync automation:
.github/workflows/readme-consistency-check.ymldetects when only one README is modifiedcontents: read,pull-requests: writeBoth READMEs now include bidirectional language switcher links.
Original prompt
Objective
Fix spelling and textual errors in README.md, add a fluent English translation (README.en.md), and implement a GitHub Action workflow to ensure both versions stay synchronized.
Changes Required
1. README.md - Corrections and Improvements
Fix the following issues in the German README.md:
Spelling and Grammar Errors:
Script Name Inconsistencies:
Fix the inconsistent script filenames throughout the document:
setup-can.sh(with hyphen)chmod +x setup_can.sh(with underscore)sudo ./setup_can_marklin.sh(different name entirely)chmod +x can-health-check.shnotsetup_can.shStandardize all references to:
setup_can_marklin.shandcan-health-check.shAdditional Improvements:
2. README.en.md - New English Translation
Create a complete, fluent English translation of README.md with the corrected content:
README.en.md3. GitHub Action Workflow - Translation Consistency Check
Create
.github/workflows/readme-consistency-check.yml:Purpose: Automatically check if both README files are updated together
Features:
actions/checkout@v4andactions/github-script@v7Workflow logic: