From 5e549e13238a853f8860e29621ab6b31ee1b9ee4 Mon Sep 17 00:00:00 2001 From: Kent Daleng Date: Sun, 16 Mar 2025 18:15:37 +0100 Subject: ci/wiki: check that (local) links are well formed (#1282) * add check-links step, fix some links * don't depend on build right now * fix fragment * reintroduce dependency for build * don't only check links on push to main * maybe this is a more sensible dependency tree for this stuff * change commented suggestions, try v2.0.2 for action * describe why we're on v2.0.2 * revert to %E2%80%90 (works with lychee anyway) --- .github/workflows/ci.yml | 14 +++++++++++++- wiki/Application-Issues.md | 4 ++-- wiki/Configuration:-Key-Bindings.md | 2 +- wiki/Configuration:-Window-Rules.md | 2 +- 4 files changed, 17 insertions(+), 5 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a61e2e2e..bdf78d78 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -228,9 +228,21 @@ jobs: - run: nix flake check continue-on-error: true + check-links: + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v4 + with: + show-progress: false + - uses: lycheeverse/lychee-action@v2.0.2 # later versions break fragment checks. don't bump until this is fixed: https://github.com/lycheeverse/lychee/issues/1574 + with: + args: --offline --include-fragments 'wiki/*.md' + publish-wiki: if: github.event_name == 'push' && github.ref == 'refs/heads/main' - needs: build + needs: + - build + - check-links permissions: contents: write runs-on: ubuntu-24.04 diff --git a/wiki/Application-Issues.md b/wiki/Application-Issues.md index 5aba0b15..b5a18e8a 100644 --- a/wiki/Application-Issues.md +++ b/wiki/Application-Issues.md @@ -9,7 +9,7 @@ Apparently, VSCode currently unconditionally queries the X server for a keymap. > [!NOTE] > Both of these issues seem to be fixed in the nightly build of WezTerm. -There's [a bug](https://github.com/wez/wezterm/issues/4708) in WezTerm that it waits for a zero-sized Wayland configure event, so its window never shows up in niri. To work around it, put this window rule in the niri config (included in the default config): +There's [a bug](https://github.com/wezterm/wezterm/issues/4708) in WezTerm that it waits for a zero-sized Wayland configure event, so its window never shows up in niri. To work around it, put this window rule in the niri config (included in the default config): ```kdl window-rule { @@ -20,7 +20,7 @@ window-rule { This empty default column width lets WezTerm pick its own initial width which makes it show up properly. -There's [another bug](https://github.com/wez/wezterm/issues/6472) in WezTerm that causes it to choose a wrong size when it's in a tiled state, and prevent resizing it. +There's [another bug](https://github.com/wezterm/wezterm/issues/6472) in WezTerm that causes it to choose a wrong size when it's in a tiled state, and prevent resizing it. Niri puts windows in the tiled state with [`prefer-no-csd`](./Configuration:-Miscellaneous.md#prefer-no-csd). So if you hit this problem, comment out `prefer-no-csd` in the niri config and restart WezTerm. diff --git a/wiki/Configuration:-Key-Bindings.md b/wiki/Configuration:-Key-Bindings.md index 513f3581..11df52a2 100644 --- a/wiki/Configuration:-Key-Bindings.md +++ b/wiki/Configuration:-Key-Bindings.md @@ -313,7 +313,7 @@ Actions for taking screenshots. - `screenshot`: opens the built-in interactive screenshot UI. - `screenshot-screen`, `screenshow-window`: takes a screenshot of the focused screen or window respectively. -The screenshot is both stored to the clipboard and saved to disk, according to the [`screenshot-path` option](./Configuration:-Miscellaneous#screenshot-path). +The screenshot is both stored to the clipboard and saved to disk, according to the [`screenshot-path` option](./Configuration:-Miscellaneous.md#screenshot-path). Since: 25.02 You can disable saving to disk for a specific bind with the `write-to-disk=false` property: diff --git a/wiki/Configuration:-Window-Rules.md b/wiki/Configuration:-Window-Rules.md index e07753fa..6505cb0e 100644 --- a/wiki/Configuration:-Window-Rules.md +++ b/wiki/Configuration:-Window-Rules.md @@ -657,7 +657,7 @@ window-rule { Set a scroll factor for all scroll events sent to a window. -This will be multiplied with the scroll factor set for your input device in the [input section](/wiki/Configuration:-Input.md#pointing-devices). +This will be multiplied with the scroll factor set for your input device in the [input section](./Configuration:-Input.md#pointing-devices). ```kdl // Make scrolling in Firefox a bit slower. -- cgit