From 7ee60c7a659735c4e4e6f96615c7cb4b0d165be1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Tur=C3=B3ci?= <64769322+mturoci@users.noreply.github.com> Date: Thu, 21 Aug 2025 15:25:43 +0200 Subject: [PATCH] docs: Fix typos in metadata page. --- docs/metadata.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/metadata.md b/docs/metadata.md index f5e0b85..d52e91d 100644 --- a/docs/metadata.md +++ b/docs/metadata.md @@ -7,10 +7,10 @@ sidebar_position: 3 The `meta` top level key can contain arbitrary metadata documenting the keyboard in question. The only fields Ergogen interprets and uses from it are: -- **`engine`**: A [semver](https://semver.org/) declaration in the usual form `[major].[minor].[patch]` (so, e.g., `3.1.4`), stating which Ergogen version the config is supposed to work with. The semver check is then performed for *compatibility*, not exact equality, so and `engine` value of `3.1.4` means "at least `3.1.4`, up to (and excluding) `4.0.0`". It is possible that you config would work even on an older or newer engine, but Ergogen will give you an error until you update either your config proper or the `engine` field to match the current environment. +- **`engine`**: A [semver](https://semver.org/) declaration in the usual form `[major].[minor].[patch]` (so, e.g., `3.1.4`), stating which Ergogen version the config is supposed to work with. The semver check is then performed for *compatibility*, not exact equality, so an `engine` value of `3.1.4` means "at least `3.1.4`, up to (and excluding) `4.0.0`". It is possible that your config would work even on an older or newer engine, but Ergogen will give you an error until you update either your config properly or the `engine` field to match the current environment. - **`version`**: Not to be confused with `engine`, `version` is just a piece of string metadata Ergogen embeds in the KiCAD PCBs it generates. - **`author`**: Same as `version`, only for the author field of the KiCAD PCB metadata. -Otherwise, feel free to dump anything here from e-mail addresses and GitHub links to your Nan's favorite pie recipe. Ergogen won't complain - only it won't use those fields either. \ No newline at end of file +Otherwise, feel free to dump anything here from e-mail addresses and GitHub links to your Nan's favorite pie recipe. Ergogen won't complain - only it won't use those fields either.