Skip to content

docs: sync READMEs and docs with v0.6.8 (Linux GA, Windows preview, 41 actions)#231

Merged
AprilNEA merged 2 commits into
masterfrom
docs/post-linux-refresh
Jun 12, 2026
Merged

docs: sync READMEs and docs with v0.6.8 (Linux GA, Windows preview, 41 actions)#231
AprilNEA merged 2 commits into
masterfrom
docs/post-linux-refresh

Conversation

@AprilNEA

Copy link
Copy Markdown
Owner

Summary

The README and docs/ lagged behind what master actually ships as of v0.6.8. This PR brings them current and adds a differentiation section.

README.md

  • 41 built-in actions (was 39 — MouseBack/MouseForward landed in feat: add mouse button 4 and 5 options #96), both in the intro and the roadmap row.
  • Windows reframed from "planned" to untested preview: signed .exe + per-user .msi (x86_64 + arm64) have shipped with every release since v0.6.7, and the WH_MOUSE_LL hook + agent port are merged — but nothing has been broadly validated on real hardware, so the install section and roadmap row say exactly that.
  • Linux install: note that packages are published for both x86_64/amd64 and arm64/aarch64 (feat(linux): sign .deb/.rpm with minisign and add arm64 packages #228).
  • New "Beyond Options+" section highlighting what OpenLogi does that Options+ won't: Linux support, the movable Gesture Button (thumb pad / middle / back / forward, per-direction bindings, or off), plain-TOML config, a real CLI, and the native (non-Electron) footprint.

Translated READMEs (zh-CN, ja, de, fr, ko)

Full rewrite mirroring the current English README. They were several eras stale — still claiming "macOS only, Linux/Windows coming soon", 6 UI languages, a 39-action catalog, and roadmap tables with no Unifying/Linux/Windows rows. Badges and the Telegram invite link are also synced to the English README's current set.

docs/CONFIGURATION.md

Rewritten for config schema v2: the unified bindings map (single action or per-direction gesture table keyed Up/Down/Left/Right/Click), gesture_owner, per_app_bindings, dpi_presets, lighting (enabled/color/brightness), and the current [app_settings] keys including language. The old page documented the legacy v1 button_bindings/gesture_bindings shape (now a deserialize-only migration shim) and claimed "there's no settings UI yet".

docs/DEVELOPMENT.md

  • Linux system-library prerequisites (mirrors CI's apt set).
  • cargo run -p xtask -- package-linux packaging section (nfpm).
  • Project layout now lists the real workspace: openlogi-hidpp, openlogi-agent-core, openlogi-agent, and the 3-platform hook description.

docs/USAGE.md

  • Document openlogi diag lighting <RRGGBB>.

Notes for review

  • The claim that Options+ pins the gesture role to the thumb pad is asserted per the project owner; please sanity-check the wording against current Options+ behavior.
  • v0.6.8's release run was still in progress when this was written; it will be the first release with Linux .deb/.rpm assets, which the Linux install section already describes.

…1 actions)

- README: 41-action catalog (MouseBack/MouseForward landed in #96), Windows
  reframed from "planned" to untested preview (signed .exe/.msi ship per
  release since v0.6.7), arm64 Linux packages, new "Beyond Options+"
  section highlighting Linux, the movable Gesture Button, plain-TOML
  config, the CLI, and the native footprint.
- Translated READMEs (zh-CN, ja, de, fr, ko): full rewrite mirroring the
  current English README — they still described the macOS-only, 6-locale,
  39-action era.
- CONFIGURATION.md: rewritten for config schema v2 (unified bindings map
  with per-direction gesture tables, gesture_owner, lighting, language);
  the documented button_bindings/gesture_bindings shape is the legacy
  deserialize-only format.
- DEVELOPMENT.md: Linux system deps, package-linux xtask, and the real
  workspace layout (openlogi-hidpp, openlogi-agent-core, openlogi-agent;
  3-platform hook).
- USAGE.md: document diag lighting.
@greptile-apps

greptile-apps Bot commented Jun 12, 2026

Copy link
Copy Markdown

Greptile Summary

This PR syncs all README and docs files with the v0.6.8 release, updating platform status (Linux GA, Windows untested preview), action count (39→41), config schema (v1→v2), and adding full translated rewrites for de, fr, ja, ko, and zh-CN.

  • README.md: Adds "Beyond Options+" differentiator section, Windows install instructions, Linux architecture note, and corrects the roadmap.
  • docs/CONFIGURATION.md: Rewritten for schema v2 — unified bindings map, gesture_owner, per_app_bindings, lighting, and a matching TOML sample.
  • docs/DEVELOPMENT.md: Adds Linux system-library prerequisites, updated workspace layout (new openlogi-hidpp, openlogi-agent-core, openlogi-agent crates), and a Linux packaging section.
  • docs/USAGE.md: Documents the new openlogi diag lighting <RRGGBB> subcommand.

Confidence Score: 5/5

Documentation-only PR with no code changes; safe to merge.

All nine changed files are Markdown. Factual claims are consistent across English README, five translations, and docs pages. Two small omissions in CONFIGURATION.md (no gesture_owner example, no Linux WM_CLASS example) are the only gaps.

docs/CONFIGURATION.md — gesture_owner and per_app_bindings Linux key format lack examples.

Important Files Changed

Filename Overview
README.md Updated action count (39→41), reframed Windows as untested preview, added Linux architecture note, added "Beyond Options+" section, and added Windows install subsection.
docs/CONFIGURATION.md Rewritten for schema v2: unified bindings map, lighting, gesture_owner, per_app_bindings. gesture_owner is described but not shown in the TOML example, and the per_app_bindings example lacks a Linux WM_CLASS illustration.
docs/DEVELOPMENT.md Adds Linux system library prerequisites, updates workspace layout to include openlogi-hidpp, openlogi-agent-core, and openlogi-agent, and documents the package-linux xtask.
docs/USAGE.md Adds openlogi diag lighting ff0000 with an inline clarifying comment; the literal hex value is explained by the comment text "any RRGGBB hex".
docs/README.de.md Full rewrite mirroring current English README: 41 actions, Linux GA, Windows preview, new "Mehr als Options+" section, updated roadmap, corrected Telegram link.
docs/README.fr.md Full rewrite mirroring current English README. Updated Telegram link, corrected action count, Linux/Windows status, and added "Au-delà d'Options+" section.
docs/README.ja.md Full rewrite in Japanese mirroring the current English README. Updated action count, platform status, roadmap, install instructions, and Telegram link.
docs/README.ko.md Full rewrite in Korean mirroring the current English README. Updated action count, platform status, roadmap, install instructions, and Telegram link.
docs/README.zh-CN.md Full rewrite in Simplified Chinese. Badge set normalized, Telegram link updated, action count and roadmap corrected.

Entity Relationship Diagram

%%{init: {'theme': 'neutral'}}%%
erDiagram
    CONFIG {
        int schema_version
        string selected_device
    }
    APP_SETTINGS {
        bool launch_at_login
        bool check_for_updates
        bool show_in_menu_bar
        string language
    }
    DEVICE {
        string device_id
        int[] dpi_presets
        string gesture_owner
    }
    BINDINGS {
        string button_name
        string action_or_table
    }
    GESTURE_BUTTON_BINDINGS {
        string Click
        string Up
        string Down
        string Left
        string Right
    }
    PER_APP_BINDINGS {
        string app_id
        string button_name
        string action
    }
    LIGHTING {
        bool enabled
        string color
        int brightness
    }
    CONFIG ||--|| APP_SETTINGS : "app_settings"
    CONFIG ||--o{ DEVICE : "devices"
    DEVICE ||--o{ BINDINGS : "bindings"
    DEVICE ||--o| GESTURE_BUTTON_BINDINGS : "bindings.GestureButton"
    DEVICE ||--o{ PER_APP_BINDINGS : "per_app_bindings"
    DEVICE ||--o| LIGHTING : "lighting"
Loading

Reviews (2): Last reviewed commit: "docs: custom shortcuts are TOML-authored..." | Re-trigger Greptile

Comment thread docs/USAGE.md Outdated
…B note

The GUI never constructs a KeyCombo — the locale files have no recorder
strings and the picker catalog excludes CustomShortcut — so 'recorded
custom shortcuts' overstated the feature in the README and all five
translations. Also clarify the diag lighting hex is any RRGGBB value
(review feedback).
@AprilNEA AprilNEA merged commit 50155d5 into master Jun 12, 2026
8 checks passed
@AprilNEA AprilNEA deleted the docs/post-linux-refresh branch June 12, 2026 13:50
@aprilnea aprilnea Bot mentioned this pull request Jun 12, 2026
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