Skip to content

docs: fix typos, doubled words, and grammar across pages (7.1)#730

Open
DeepDiver1975 wants to merge 2 commits into
7.1from
fix/docs-grammar-typos-7.1
Open

docs: fix typos, doubled words, and grammar across pages (7.1)#730
DeepDiver1975 wants to merge 2 commits into
7.1from
fix/docs-grammar-typos-7.1

Conversation

@DeepDiver1975

Copy link
Copy Markdown
Member

Summary

Port of #729 to the 7.1 release branch. 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"

Companion PR targeting master: #729.

🤖 Generated with Claude Code

DeepDiver1975 and others added 2 commits June 18, 2026 17:29
ci: build the 7.1 version branch

Add the 7.1 branch to the CI push triggers so content changes
backported from master to 7.1 are built. The 7.1 release branch has
been created and configured separately.

Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
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

This PR ports #729 to the 7.1 release branch: a focused copy-editing pass over the AsciiDoc prose plus one CI change. 12 files, +33/-32. I reviewed the full diff (it is small enough to read in its entirety). The corrections are genuine and accurate, AsciiDoc markup is intact, and no xref/link targets are altered. This is a clean, low-risk change.

Code quality / style

  • All typo/spelling fixes are correct: CompatiblilityCompatibility, availabeavailable, syncronizationsynchronization, resouresresources, synchroinizesynchronize, opperatingoperating, PlacehholderPlaceholder, synchrinozationsynchronization.
  • Image alt-text fixes (SynbolSymbol, IngnoredIgnored, Start MenueStart Menu, CLog filesLog files) are made entirely inside image:[...] / image::[...] macro brackets — the macros, image paths, and width= attributes are untouched. Markup is preserved.
  • Doubled-word removals (the the, restarts ... restarts, indicating that indicates that, a paused sync operationsoperation) are correct.
  • The can´t (acute accent) → can't fix is a real correctness fix, not cosmetic.
  • The vfs.adoc xref (xref:troubleshooting.adoc#error-updating-metadata-access-denied[Troubleshooting]) is left fully intact; only the duplicated trailing "for more details" prose outside the macro was removed. Good — no link breakage.
  • Parenthesizing the file-statuses list in vfs.adoc and the web_app.adoc comma fix (The the backend, needs toThe backend needs to) read correctly.

Specific suggestions

  • Minor consistency nit (non-blocking): the PR standardizes "Desktop app"→"Desktop App" in conflicts.adoc, but using.adoc still contains "represented by the Desktop app" in the "Managing Resources to Synchronize" paragraph that this PR touches. If the goal is consistent capitalization, that instance could be included too. Not required for merge.
  • faq.adoc: changes the mtime of the fileschanges their modification times is fine, though the surrounding text still introduces the term "mtime" — reusing "mtime" would have been equally valid. No action needed.

Potential issues / risks

  • The PR summary documents the prose edits but does not mention the .github/workflows/ci.yml change, which adds '7.1' to the CI push branch triggers. This is a sensible and expected addition for a new release branch (so the 7.1 branch gets built/checked), and it is correct, but it is worth calling out since it is the only non-docs / behavior-affecting change in the PR. Recommend noting it in the description for traceability.
  • No AsciiDoc structural changes (no heading-level, attribute, conditional ifeval, or include changes), so build/render risk is negligible.

LGTM. No blocking issues.

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