aboutsummaryrefslogtreecommitdiff
path: root/wiki
diff options
context:
space:
mode:
authorIvan Molodetskikh <yalterz@gmail.com>2024-09-04 13:15:43 +0300
committerIvan Molodetskikh <yalterz@gmail.com>2024-09-04 13:15:43 +0300
commit4543873dae1fdfd0b1b9a028d168ada97ab011b2 (patch)
tree434e6c63e76657ff717da567c81e6a5a2d6b8a0f /wiki
parenta2c855315c09ae5b4cc686a4605da7d5fdb99b48 (diff)
downloadniri-4543873dae1fdfd0b1b9a028d168ada97ab011b2.tar.gz
niri-4543873dae1fdfd0b1b9a028d168ada97ab011b2.tar.bz2
niri-4543873dae1fdfd0b1b9a028d168ada97ab011b2.zip
wiki/IPC: Link to the online rustdoc
Diffstat (limited to 'wiki')
-rw-r--r--wiki/IPC.md6
1 files changed, 2 insertions, 4 deletions
diff --git a/wiki/IPC.md b/wiki/IPC.md
index 261f4271..871d9de6 100644
--- a/wiki/IPC.md
+++ b/wiki/IPC.md
@@ -26,7 +26,7 @@ To get a taste of the events, run `niri msg event-stream`.
Though, this is more of a debug function than anything.
You can get raw events from `niri msg --json event-stream`, or by connecting to the niri socket and requesting an event stream manually.
-You can find the full list of events along with documentation in the [niri-ipc sub-crate][niri-ipc].
+You can find the full list of events along with documentation [here](https://yalter.github.io/niri/niri_ipc/enum.Event.html).
### Programmatic Access
@@ -57,7 +57,7 @@ $ env NIRI_SOCKET=./temp.sock niri msg action focus-workspace 2
{"Action":{"FocusWorkspace":{"reference":{"Index":2}}}}
```
-You can find all available requests and response types in the [niri-ipc sub-crate][niri-ipc].
+You can find all available requests and response types in the [niri-ipc sub-crate documentation](https://yalter.github.io/niri/niri_ipc/).
### Backwards Compatibility
@@ -75,5 +75,3 @@ Please prefer the JSON output for scripts, since I reserve the right to make any
The `niri-ipc` sub-crate (like other niri sub-crates) is *not* API-stable in terms of the Rust semver; rather, it follows the version of niri itself.
In particular, new struct fields and enum variants will be added.
-
-[niri-ipc]: https://github.com/YaLTeR/niri/tree/main/niri-ipc