From 2cd5884f21305c7b6679ca3631d1502a0b2d1a8d Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Thu, 29 Oct 2026 13:40:10 -0700 Subject: [PATCH] docs(schema): regenerate schemas, nix options and cli docs Bring the generated files back in line with the code on master. - schema.json: add monocle_focus_behaviour and the MonocleFocusBehaviour definition. schema.asc.json and schema.bar.json were already current. - nix/komorebi-options.nix: add the monocle_focus_behaviour option. nix/komorebi-bar-options.nix was already current. - docs/cli: add the pages for layout-ratios, monocle-focus-behaviour, permissions and toggle-monocle-focus-behaviour. Update 19 pages for the --bar flag of enable-autostart, the per-value help of enum arguments and reworded help text. Re-wrap 4 pages whose text did not change. How the files were made: - schemars-nixgen writes the properties of an object in a different order on every run, so the files are not regenerated whole. Only the new option is added; the rest of a full run was checked to be the same lines in another order. - docgen on master writes a bare fence with no heading and "Usage: name", where the pages in docs/cli have a "# name" heading and "Usage: komorebic name". The pages keep the format they have. - Pages are wrapped at 100 columns, the width docgen uses when it does not write to a terminal, instead of the width of the terminal the old pages were made in. --- docs/cli/adjust-container-padding.md | 6 ++- docs/cli/adjust-workspace-padding.md | 6 ++- docs/cli/animation-style.md | 37 +++++++++++++++++-- docs/cli/change-layout.md | 13 ++++++- docs/cli/cross-monitor-move-behaviour.md | 6 ++- docs/cli/enable-autostart.md | 3 ++ docs/cli/flip-layout.md | 7 +++- docs/cli/ignore-rule.md | 8 +++- docs/cli/initial-named-workspace-rule.md | 8 +++- docs/cli/initial-workspace-rule.md | 8 +++- docs/cli/layout-ratios.md | 18 +++++++++ docs/cli/manage-rule.md | 8 +++- docs/cli/monocle-focus-behaviour.md | 20 ++++++++++ docs/cli/named-workspace-layout-rule.md | 13 ++++++- docs/cli/named-workspace-layout.md | 13 ++++++- docs/cli/named-workspace-rule.md | 8 +++- docs/cli/permissions.md | 12 ++++++ docs/cli/query.md | 4 +- docs/cli/resize-axis.md | 11 ++++-- docs/cli/resize-edge.md | 6 ++- docs/cli/toggle-monocle-focus-behaviour.md | 12 ++++++ docs/cli/toggle-workspace-float-override.md | 4 +- ...le-workspace-window-container-behaviour.md | 3 +- .../unmanaged-window-operation-behaviour.md | 4 +- docs/cli/workspace-layout-rule.md | 13 ++++++- docs/cli/workspace-layout.md | 13 ++++++- docs/cli/workspace-rule.md | 8 +++- nix/komorebi-options.nix | 12 ++++++ schema.json | 27 ++++++++++++++ 29 files changed, 268 insertions(+), 43 deletions(-) create mode 100644 docs/cli/layout-ratios.md create mode 100644 docs/cli/monocle-focus-behaviour.md create mode 100644 docs/cli/permissions.md create mode 100644 docs/cli/toggle-monocle-focus-behaviour.md diff --git a/docs/cli/adjust-container-padding.md b/docs/cli/adjust-container-padding.md index f96f1929..e6b233b6 100644 --- a/docs/cli/adjust-container-padding.md +++ b/docs/cli/adjust-container-padding.md @@ -7,13 +7,15 @@ Usage: komorebic adjust-container-padding Arguments: - [possible values: increase, decrease] + Possible values: + - increase: Increase + - decrease: Decrease Pixels to adjust by as an integer Options: -h, --help - Print help + Print help (see a summary with '-h') ``` \ No newline at end of file diff --git a/docs/cli/adjust-workspace-padding.md b/docs/cli/adjust-workspace-padding.md index 5045aa95..8b3f55e7 100644 --- a/docs/cli/adjust-workspace-padding.md +++ b/docs/cli/adjust-workspace-padding.md @@ -7,13 +7,15 @@ Usage: komorebic adjust-workspace-padding Arguments: - [possible values: increase, decrease] + Possible values: + - increase: Increase + - decrease: Decrease Pixels to adjust by as an integer Options: -h, --help - Print help + Print help (see a summary with '-h') ``` \ No newline at end of file diff --git a/docs/cli/animation-style.md b/docs/cli/animation-style.md index a8b47396..513f09b0 100644 --- a/docs/cli/animation-style.md +++ b/docs/cli/animation-style.md @@ -8,10 +8,41 @@ Usage: komorebic animation-style [OPTIONS] Options: -s, --style