From b86608442dccc1fb098afaff196138f965368ff4 Mon Sep 17 00:00:00 2001 From: Oskar Manhart <52569953+oskardotglobal@users.noreply.github.com> Date: Sat, 11 Jul 2026 15:05:28 +0200 Subject: [PATCH 1/3] Revise CONTRIBUTING.md and add AI policy --- CONTRIBUTING.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ea778b..642f595 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,20 @@ # Contributing -We are really happy that you want to contribute. -To help you get started please read this document. +We are really happy that you want to contribute. To help you get started, please read this document. -## Current tech stack +## Tooling -We currently moved from Obsidian to plain markdown so there you might encounter -some artifacts. (Feel free to create a PR). +Please use [rumdl](https://rumdl.dev) to lint and format your markdown. This is also checked in CI. +Also, spell-check your work using something like . Currently, this is not done in CI. -If possible please use rumdl or similar for uniform markdown formatting. +## Style + +Our docs are supposed to be tutorial-like and beginner friendly. For technical details, explain them in the glossary at the bottom of a guide +or link to a source, if the reader wants to go down a rabbit hole that's fine. You are free to use colloquial language if that improves the flow of the text. + +## AI policy + +Please do not submit AI/LLM-generated writing. LLMs are useful for many thing, writing prose is not one of them. +Our docs are written by humans who put a lot of effort into having a nice end result. Many readers can tell if writing was AI-generated and +that doesn't accurately reflect the time that goes into working on these docs. If we were to just have LLMs write our docs, +there is little benefit to the reader -- they might as well ask their LLM of choice instead of referring to our resources. From f3cc586c6f90db8af97a56cf27bb60b4671fd371 Mon Sep 17 00:00:00 2001 From: Oskar Manhart <52569953+oskardotglobal@users.noreply.github.com> Date: Sat, 11 Jul 2026 15:08:28 +0200 Subject: [PATCH 2/3] rumdl check --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 642f595..97b032a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ We are really happy that you want to contribute. To help you get started, please ## Tooling Please use [rumdl](https://rumdl.dev) to lint and format your markdown. This is also checked in CI. -Also, spell-check your work using something like . Currently, this is not done in CI. +Also, spell-check your work using something like . Currently, this is not done in CI. ## Style From 570a5a7a9db9a84b34712625539851fe998d05c7 Mon Sep 17 00:00:00 2001 From: Oskar Manhart <52569953+oskardotglobal@users.noreply.github.com> Date: Sat, 11 Jul 2026 15:10:41 +0200 Subject: [PATCH 3/3] address languagetool comments --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 97b032a..d35e4c7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,12 +4,12 @@ We are really happy that you want to contribute. To help you get started, please ## Tooling -Please use [rumdl](https://rumdl.dev) to lint and format your markdown. This is also checked in CI. -Also, spell-check your work using something like . Currently, this is not done in CI. +Please use [rumdl](https://rumdl.dev) to lint and format your Markdown. +Also, spell-check your work using something like . Both of these are also done in CI. ## Style -Our docs are supposed to be tutorial-like and beginner friendly. For technical details, explain them in the glossary at the bottom of a guide +Our docs are supposed to be tutorial-like and beginner-friendly. For technical details, explain them in the glossary at the bottom of a guide or link to a source, if the reader wants to go down a rabbit hole that's fine. You are free to use colloquial language if that improves the flow of the text. ## AI policy