docs: sync READMEs and docs with v0.6.8 (Linux GA, Windows preview, 41 actions)#231
Merged
Conversation
…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 SummaryThis 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.
Confidence Score: 5/5Documentation-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
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"
Reviews (2): Last reviewed commit: "docs: custom shortcuts are TOML-authored..." | Re-trigger Greptile |
…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).
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
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
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
MouseBack/MouseForwardlanded in feat: add mouse button 4 and 5 options #96), both in the intro and the roadmap row..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.x86_64/amd64andarm64/aarch64(feat(linux): sign .deb/.rpm with minisign and add arm64 packages #228).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
bindingsmap (single action or per-direction gesture table keyedUp/Down/Left/Right/Click),gesture_owner,per_app_bindings,dpi_presets,lighting(enabled/color/brightness), and the current[app_settings]keys includinglanguage. The old page documented the legacy v1button_bindings/gesture_bindingsshape (now a deserialize-only migration shim) and claimed "there's no settings UI yet".docs/DEVELOPMENT.md
cargo run -p xtask -- package-linuxpackaging section (nfpm).openlogi-hidpp,openlogi-agent-core,openlogi-agent, and the 3-platform hook description.docs/USAGE.md
openlogi diag lighting <RRGGBB>.Notes for review
.deb/.rpmassets, which the Linux install section already describes.