Skip to content

docs(readme): trim comparison prose, drop star icons/counts#45

Merged
BlackHole1 merged 1 commit into
mainfrom
docs/trim-comparison
Jun 30, 2026
Merged

docs(readme): trim comparison prose, drop star icons/counts#45
BlackHole1 merged 1 commit into
mainfrom
docs/trim-comparison

Conversation

@BlackHole1

Copy link
Copy Markdown
Member

Follow-up to #44. The comparison table landed fine, but the prose around it was too heavy: the "where LockIME fits" note was a single dense paragraph, and the intro and "other tools" lists carried decorative glyphs and GitHub star counts — noise that also goes stale.

This drops every and star count (a qualitative "most widely-used" still conveys popularity), splits the dense block into a short "Choosing between them" plus a one-line "Other tools", folds the legend into the footnote, and cuts the closing note to a single line. The comparison table itself is untouched — net −60 lines.

Per the README i18n rule, the same trim is applied to all eight translations under docs/README/, kept row-for-row in sync.

The comparison table stays, but the prose around it was too heavy: the
"where LockIME fits" note was one dense paragraph, and the intro and
"other tools" lists leaned on decorative `★` glyphs and GitHub star
counts that add noise and go stale.

Drop every `★` and star count, and let "most widely-used" carry the
popularity point qualitatively. Split the dense block into a short
"Choosing between them" plus a compact "Other tools" line, fold the
`—` legend into the footnote, and cut the closing note to one line.
The table itself is unchanged.

Per the README i18n rule, the same trim is applied to all eight
translations under `docs/README/`, kept row-for-row in sync.

Signed-off-by: Kevin Cui <bh@bugs.cc>
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: dd0d4d1a-3511-4550-af9a-1a1de25f79b3

📥 Commits

Reviewing files that changed from the base of the PR and between c7e61e8 and 87592bf.

📒 Files selected for processing (9)
  • README.md
  • docs/README/README.de.md
  • docs/README/README.es.md
  • docs/README/README.fr.md
  • docs/README/README.ja.md
  • docs/README/README.pt.md
  • docs/README/README.ru.md
  • docs/README/README.zh-CN.md
  • docs/README/README.zh-TW.md

Summary by CodeRabbit

  • Documentation
    • Revised the README comparison sections across multiple languages.
    • Simplified and clarified the product comparison narrative, emphasizing continuous locking behavior versus one-time switching.
    • Restructured the guidance on choosing between tools and shortened the “other tools” sections.
    • Updated comparison notes and footnotes to make availability, permissions, and timing details clearer.

Walkthrough

The Comparison section across README.md and all eight localized README files (German, Spanish, French, Japanese, Portuguese, Russian, Simplified Chinese, Traditional Chinese) was rewritten. The opening paragraph now more concisely frames LockIME as centered on continuous re-locking on input source drift, with per-rule fallback to one-time switching. The post-table guidance was restructured from a single "Where LockIME fits" block into two shorter blocks: "Choosing between them" and "Other tools." The closing blockquote was updated to reference mid-2026 as the comparison baseline, and the "—" symbol was clarified as indicating an undocumented capability rather than a confirmed absence.

Possibly related PRs

  • oomol-lab/LockIME#44: Added the original Comparison sections (LockIME vs Input Source Pro/KeyboardHolder wording and structure) across the root README and all translated docs that this PR edits.
🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title follows the required type(scope): subject format and accurately summarizes the README comparison cleanup.
Description check ✅ Passed The description clearly matches the README comparison prose cleanup and translation sync changes in this pull request.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/trim-comparison

Comment @coderabbitai help to get the list of available commands.

@BlackHole1 BlackHole1 merged commit 48cbd91 into main Jun 30, 2026
3 checks passed
@BlackHole1 BlackHole1 deleted the docs/trim-comparison branch June 30, 2026 06:16
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