Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
Comment thread
oskardotglobal marked this conversation as resolved.
Resolved
Also, spell-check your work using something like <https://languagetool.org/>. 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.
Comment thread
oskardotglobal marked this conversation as resolved.
Resolved
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.
Loading