chore(docs): proofread README and docs prose for grammar and style#362
Merged
Merged
Conversation
Fix broken grammar and inconsistent capitalisation in the README, unify the German address form to the dominant impersonal infinitive, spell out abbreviations on first use, and align em-dash spacing and a heading to the established project style. README is Vale-clean and all include-markdown markers are preserved. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
Proofread the README and the bilingual MkDocs documentation as an editor and apply the fixes. Corrects broken grammar, inconsistent capitalisation, mixed German address forms, and unexpanded abbreviations across six files while preserving all include-markdown markers and the established project style.
Changes
README.md(workflow/Probot tables, development section); expandCISand replace the informalGitRepodocs/en/portfolio-app/setup.md: clarify the Issues-permission cell, align em-dash spacing to the project style, recast a passive clausedocs/de/portfolio-app/setup.md: unify the address form to the impersonal infinitive, spell outPAT,PEM,TTLon first usedocs/de/probot/settings.mdanddocs/de/workflows/release.md: replace remaining Du-form imperatives on reference/admonition prosedocs/de/development/index.md: translate theProse-Lintingheading toProsa-LintingLinked issues
None
Testing
vale README.md→ 0 errors, 0 warnings, 0 suggestionsvale docs/en/portfolio-app/setup.md→ only pre-existingautolinksspelling alerts (GitHub terminology in unchanged text)pre-commit(check-yaml, end-of-files, trailing-whitespace) → Passed on all six filesREADME.mdRisk / rollout notes
Documentation-only change; no workflow, Probot, or Renovate config touched. README and docs propagate to the published MkDocs site on the next
developpush. Low risk.