From 97e52a6946fef2ef3fc04a2a4f1e4b47d3562613 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= Date: Fri, 27 Jun 2025 15:36:29 +0200 Subject: [PATCH] markdown: ignore trailing whitespace --- docs/site/guides/mesh-vpn.md | 2 +- docs/site/guides/secure-boot.md | 2 +- docs/site/reference/glossary.md | 2 +- pkgs/agit/README.md | 2 +- pkgs/clan-app/README.md | 6 +++--- pkgs/clan-app/ui/src/components/v2/README.md | 6 +++--- pkgs/clan-vm-manager/README.md | 4 ++-- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/site/guides/mesh-vpn.md b/docs/site/guides/mesh-vpn.md index 9e25448bf..46a25e1e7 100644 --- a/docs/site/guides/mesh-vpn.md +++ b/docs/site/guides/mesh-vpn.md @@ -52,7 +52,7 @@ This guide shows you how to configure `zerotier` either through `NixOS Options` }; }; ``` - + ## 3. Apply the Configuration Update the `controller` machine: diff --git a/docs/site/guides/secure-boot.md b/docs/site/guides/secure-boot.md index 9514ec580..3fe5cabd5 100644 --- a/docs/site/guides/secure-boot.md +++ b/docs/site/guides/secure-boot.md @@ -5,7 +5,7 @@ At the moment, NixOS/Clan does not support [Secure Boot](https://wiki.gentoo.org ### Step 2: Access the UEFI/BIOS Menu - Restart your computer. -- As your computer restarts, press the appropriate key to enter the UEFI/BIOS settings. +- As your computer restarts, press the appropriate key to enter the UEFI/BIOS settings. ??? tip "The key depends on your laptop or motherboard manufacturer. Click to see a reference list:" | Manufacturer | UEFI/BIOS Key(s) | diff --git a/docs/site/reference/glossary.md b/docs/site/reference/glossary.md index b9f73b225..67bb0585f 100644 --- a/docs/site/reference/glossary.md +++ b/docs/site/reference/glossary.md @@ -21,7 +21,7 @@ Flake URL-like syntax used to link to clans. Required to connect the `url-open` application to the `clan-app`. ## facts *(deprecated)* -System for creating secrets and public files in a declarative way. +System for creating secrets and public files in a declarative way. **Note:** Deprecated, use `vars` instead. ## inventory diff --git a/pkgs/agit/README.md b/pkgs/agit/README.md index 38fd950e9..04590c9b8 100644 --- a/pkgs/agit/README.md +++ b/pkgs/agit/README.md @@ -36,7 +36,7 @@ Examples: $ agit list Lists all open pull requests for the current repository - + ``` References: diff --git a/pkgs/clan-app/README.md b/pkgs/clan-app/README.md index 14cbcc41b..aff0d825d 100644 --- a/pkgs/clan-app/README.md +++ b/pkgs/clan-app/README.md @@ -52,7 +52,7 @@ Follow the instructions below to set up your development environment and start t ## Storybook -We use [Storybook] to develop UI components. +We use [Storybook] to develop UI components. It can be started by running the following: ```console @@ -63,10 +63,10 @@ This will start a [process-compose] instance containing two processes: * `storybook` which is the main [storybook] process. * `luakit` which is a [webkit]-based browser for viewing the stories with. This is the same underlying engine used when -rendering the app. +rendering the app. You can run storybook tests with `npm run test-storybook`. -If you change how a component(s) renders, +If you change how a component(s) renders, you will need to update the snapshots with `npm run test-storybook-update-snapshots`. ## Start clan-app without process-compose diff --git a/pkgs/clan-app/ui/src/components/v2/README.md b/pkgs/clan-app/ui/src/components/v2/README.md index 8161aed5c..9dc27627f 100644 --- a/pkgs/clan-app/ui/src/components/v2/README.md +++ b/pkgs/clan-app/ui/src/components/v2/README.md @@ -1,7 +1,7 @@ ## Overview -We will be updating existing components and developing new components in line with the latest designs inside this -folder. As they become ready, they can be copied into the root `components` folder, replacing any existing components as +We will be updating existing components and developing new components in line with the latest designs inside this +folder. As they become ready, they can be copied into the root `components` folder, replacing any existing components as necessary. -This is to avoid merge hell and allow us to rapidly match the latest designs without the burden of integration. \ No newline at end of file +This is to avoid merge hell and allow us to rapidly match the latest designs without the burden of integration. \ No newline at end of file diff --git a/pkgs/clan-vm-manager/README.md b/pkgs/clan-vm-manager/README.md index 0d0d504e5..5e2282e37 100644 --- a/pkgs/clan-vm-manager/README.md +++ b/pkgs/clan-vm-manager/README.md @@ -89,6 +89,6 @@ Here are some important documentation links related to the Clan VM Manager: ## Error handling -> Error dialogs should be avoided where possible, since they are disruptive. -> +> Error dialogs should be avoided where possible, since they are disruptive. +> > For simple non-critical errors, toasts can be a good alternative.