Skip to content

docs: fix typos, doubled words, and grammar across pages#729

Open
DeepDiver1975 wants to merge 1 commit into
masterfrom
fix/docs-grammar-typos
Open

docs: fix typos, doubled words, and grammar across pages#729
DeepDiver1975 wants to merge 1 commit into
masterfrom
fix/docs-grammar-typos

Conversation

@DeepDiver1975

Copy link
Copy Markdown
Member

Summary

A copy-editing pass over the documentation prose, fixing spelling, typos, doubled words, and a few small grammar/clarity issues. No content meaning or markup-behavior changes.

Typos / spelling

  • index.adoc — "Compatiblility" → "Compatibility"
  • using.adoc — "availabe" → "available"; "syncronization" → "synchronization"; "resoures" → "resources"; image alt-text "Synbol" → "Symbol" (×4) and "Ingnored" → "Ignored" (×2)
  • installing.adoc — image alt-text "Start Menue" → "Start Menu" (×2)
  • troubleshooting.adoc — "synchroinize" → "synchronize"; image alt-text "CLog files to keep" → "Log files to keep" (×2)
  • filenames.adoc — wrong character can´t (acute accent) → can't
  • vfs.adoc — "synchrinozation.." → "synchronization."; "Placehholder" → "Placeholder" (×3)
  • removing.adoc — "opperating" → "operating"

Doubled words / grammar

  • using.adoc — "a paused sync operations" → "operation"
  • installing.adoc — "Now, the the Desktop.ini" → "Now, the Desktop.ini"
  • troubleshooting.adoc — "retained across restarts of the Desktop App restarts." → drop trailing "restarts"
  • filenames.adoc — "indicating that indicates that the file" → "indicating that the file"
  • web_app.adoc — "The the backend, needs to" → "The backend needs to"
  • automatic_updater.adoc — "macOS Linux users" → "macOS and Linux users"

Minor clarity / consistency

  • conflicts.adoc — "Desktop app" → "Desktop App" (consistency)
  • vfs.adoc — parenthesize the file-statuses list; drop a duplicated "for more details"
  • faq.adoc — tighten "changes the mtime of the files" → "changes their modification times"
  • filenames.adoc — reword "put on top of this document to highlight"; "likely to get problems" → "likely to cause problems"

Notes

These were verified against the rendered prose; American/British spelling mixing (e.g. "Synchronisation"/"behaviour") was left intentionally untouched as it is used consistently in the project. A companion PR will port these fixes to the 7.1 branch.

🤖 Generated with Claude Code

Copy-editing pass over the documentation prose: corrects misspellings
(Compatiblility, availabe, syncronization, resoures, synchroinize,
synchrinozation, Ingnored, Start Menue, CLog, opperating, Placehholder,
Synbol), removes doubled words ("the the", "restarts ... restarts",
"indicating that indicates that"), fixes a wrong apostrophe character,
adds a missing "and" in "macOS and Linux", and applies a few small
clarity/consistency edits (Desktop App capitalization, redundant
phrasing). No content or markup behavior changes.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com>

@DeepDiver1975 DeepDiver1975 left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 Automated review by Claude Code review agent.

Overview

A focused copy-editing pass across 11 AsciiDoc pages: 32 insertions / 32 deletions, purely prose. The changes are well-scoped, accurately summarized in the PR description, and contain no logic or build-config edits. All corrections are genuine and improve the docs. I recommend merging.

This PR targets master and is the companion of PR #730 (same title plus "(7.1)") which targets the 7.1 branch. They are an intentional forward-port/back-port pair, not duplicates — #730 has one extra changed file and one extra insertion, so the branches have drifted slightly and should not simply be assumed identical.

Code quality / style

  • All edits are real corrections: misspellings ("Compatiblility", "availabe", "syncronization", "resoures", "synchroinize", "opperating", "Placehholder", "synchrinozation.."), doubled words ("the the", "Desktop App restarts" trailing dup, "indicating that indicates that"), and a wrong glyph (can´t acute accent → can't).
  • Image alt-text fixes ("Synbol"→"Symbol", "Ingnored"→"Ignored", "Start Menue"→"Start Menu", "CLog files"→"Log files") touch only the bracketed alt text; image targets/paths are untouched, so rendering is unaffected.
  • AsciiDoc markup is preserved throughout: attribute references ({ini_name}, {description}), ifeval/endif blocks, menu:/btn: macros, image:/image::, and the xref:troubleshooting.adoc#error-updating-metadata-access-denied[...] cross-reference all remain syntactically intact.
  • Terminology consistency is improved: conflicts.adoc "Desktop app" → "Desktop App" matches the capitalization used elsewhere. (Note: using.adoc and web_app.adoc still contain other lowercase "Desktop app" instances not touched here — out of scope, just noting for a future pass.)
  • British/American spelling (e.g. "Synchronisation", "behaviour") left untouched as stated; this is the right call given the project mixes them consistently.

Specific suggestions

  • vfs.adoc: "synchrinozation.." → "synchronization." correctly fixes both the typo and the doubled period. Good.
  • filenames.adoc: "The following examples are put on top of this document to highlight..." → "The following examples illustrate..." is a clear improvement; the original phrasing was awkward and the new version reads naturally.
  • faq.adoc: "changes the mtime of the files" → "changes their modification times" — reads better, though note the page still uses the term "mtime" earlier (defined as "modification date/time (mtime)"), so the terminology shift here is minor and acceptable.
  • No action required, but if a follow-up is desired, the remaining lowercase "Desktop app" occurrences noted above could be normalized.

Potential issues / risks

  • None functional. Alt-text-only changes carry no rendering risk.
  • Trailing whitespace: several edited lines in filenames.adoc and using.adoc still end with a trailing space (pre-existing, not introduced by this PR). Not blocking.
  • Coordination risk: ensure #729 (master) and #730 (7.1) stay in sync; since the diffs already differ by one file, double-check no master-only fix was dropped from 7.1 or vice versa before both land.

Overall: clean, low-risk, and clearly beneficial. LGTM.

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.

1 participant