mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-19 07:08:48 +01:00
docs(linux): paths and links name the consolidated layout
The KDE docs were moved from komorebi-for-kde/ to docs/linux/ and the sources, nix files, scripts and schemas to komorebi-linux/, nix/linux/, scripts/linux/ and schemas/linux/, so every relative link that left docs/ (to sources, nix files, scripts, schemas, .envrc, rust-toolchain.toml, the old CI file) was broken, and the text named the old paths. Links were rewritten mechanically by resolving each broken target against the old location and mapping it to the new one; link texts and code-span paths were updated to the new paths (komorebi/src -> komorebi-linux/src, nix/ -> nix/linux/, scripts/ -> scripts/linux/, docs/ -> docs/linux/, schema.json -> schemas/linux/schema.json). The crate list of the README names komorebi-linux, komorebi-daemon and komorebi-version; `cargo install --path komorebi` becomes komorebi-daemon; the comparison paragraph of CONTRIBUTING.md says compare-gen.py is stale (it looks for the old sibling trees). URLs of the old GitHub repositories are left as they are (a release decision). COMPARE.md is left as it is (already marked stale). Verified: a link checker over every markdown file (outside cli/, nix/, tools/, old-ci) reports no broken link in docs/linux. Nothing was built.
This commit is contained in:
1 parent
5b2381efb4
commit
a7b78cc7e4
20 files changed
+358
-355
No files matched your search
@@ -67,7 +67,7 @@ extension `.json` is read.
|
||||
|
||||
## The file komorebi ships
|
||||
|
||||
[`komorebic/applications.json`](../../komorebic/applications.json) in the repository has an
|
||||
[`komorebic/applications.json`](../../../komorebic/applications.json) in the repository has an
|
||||
entry for KDE Plasma, which floats the calculators of KDE and GNOME, the screenshot tool, the
|
||||
authentication dialog of Plasma and System Settings. A test loads it, and opens the windows it
|
||||
names.
|
||||
@@ -244,8 +244,8 @@ rule of the workspace away and leave it with the layout it has.
|
||||
## The schema
|
||||
|
||||
The Rust types that read `komorebi.json` also describe it as a JSON Schema, which an editor can
|
||||
check the file against, and which the NixOS module is typed from. [`schema.json`](../../schema.json)
|
||||
in the repository is the schema of `komorebi.json`, [`schema.asc.json`](../../schema.asc.json) the
|
||||
check the file against, and which the NixOS module is typed from. [`schemas/linux/schema.json`](../../../schemas/linux/schema.json)
|
||||
in the repository is the schema of `komorebi.json`, [`schemas/linux/schema.asc.json`](../../../schemas/linux/schema.asc.json) the
|
||||
schema of an [`applications.json`](application-specific-configuration.md), and the commands print
|
||||
them (and two more), without a daemon:
|
||||
|
||||
|
||||
@@ -5,12 +5,12 @@
|
||||
[`komorebic quickstart`](../cli/quickstart.md) writes three example files into the config home
|
||||
(`~/.config/komorebi`, or `$KOMOREBI_CONFIG_HOME`), which it makes if it has to:
|
||||
|
||||
- `komorebi.json`, which is [`docs/komorebi.example.json`](../example-configurations.md):
|
||||
- `komorebi.json`, which is [`docs/linux/example-configurations.md`](../example-configurations.md):
|
||||
eight workspaces on the first monitor, each with another layout, and some padding;
|
||||
- `applications.json`, which is
|
||||
[`komorebic/applications.json`](application-specific-configuration.md#the-file-komorebi-ships),
|
||||
[`docs/linux/usage/application-specific-configuration.md`](application-specific-configuration.md#the-file-komorebi-ships),
|
||||
the rules `komorebi.json` names for the applications that need them;
|
||||
- `skhdrc`, which is [`docs/skhdrc.sample`](../skhdrc.sample): the [key bindings](keybindings.md)
|
||||
- `skhdrc`, which is [`docs/linux/skhdrc.sample`](../skhdrc.sample): the [key bindings](keybindings.md)
|
||||
of the sample, in the format of skhd, which the daemon and `komorebic hotkeys compile` read from
|
||||
there.
|
||||
|
||||
|
||||
@@ -165,5 +165,5 @@ komorebic completions bash > ~/.local/share/bash-completion/completions/komorebi
|
||||
|
||||
## Every command
|
||||
|
||||
[`docs/cli`](../cli/start.md) has a page for every `komorebic` command, generated from its
|
||||
[`docs/linux/cli/start.md`](../cli/start.md) has a page for every `komorebic` command, generated from its
|
||||
help with `just docgen`.
|
||||
@@ -8,7 +8,7 @@ Base16 palette of your own.
|
||||
|
||||
There is no `komorebic` command for it: the daemon takes it from the `theme` key of
|
||||
[`komorebi.json`](configuration.md#borders), or as a message on its socket, the `Theme` message,
|
||||
which a program sends with [`komorebi-client`](../../komorebi-client/src/lib.rs) or a script writes
|
||||
which a program sends with [`komorebi-client`](../../../komorebi-client/src/lib.rs) or a script writes
|
||||
as a line of JSON.
|
||||
|
||||
```rust
|
||||
|
||||
Reference in new issue
Block a user