diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ea778b..d35e4c7 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. +Also, spell-check your work using something like . Both of these are also 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.