From 0751699bc88e6fdfc52350e7df411f3cea57748e Mon Sep 17 00:00:00 2001
From: Tasia Iso <tasiaiso@proton.me>
Date: Sat, 11 May 2024 21:22:25 +0200
Subject: [PATCH] docs: more docs guidelines

---
 docs/contributing.md                        | 10 ++++++-
 docs/guidelines/documentation-guidelines.md | 32 ++++++++++++++++++++-
 2 files changed, 40 insertions(+), 2 deletions(-)

diff --git a/docs/contributing.md b/docs/contributing.md
index 554c1436..4804ee11 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -12,12 +12,20 @@ Alternatively, you can change the `origin` remote on your existing clone:
 
     - I want to edit C code !
 
+    TODO
+
     - I want to edit JavaScript code !
 
+    TODO
+
     - I want to write documentation !
 
     Great! Before you do, have a look at the [documentation guidelines](guidelines/documentation-guidelines.md) to learn how to write consistent documentation.
-    
+
+    In all cases:
+
+    - Make sure that your commit messages are descriptive.
+
 - Format your changes:
 
 If you've edited C code: run `make format`
diff --git a/docs/guidelines/documentation-guidelines.md b/docs/guidelines/documentation-guidelines.md
index 1be46d20..039434dc 100644
--- a/docs/guidelines/documentation-guidelines.md
+++ b/docs/guidelines/documentation-guidelines.md
@@ -26,7 +26,37 @@ When writing documentation, the author should have in mind it's target audience:
 
 ### Style guide
 
-TODO
+1. Lines SHOULD NOT be wrapped, to allow clients to dynamically wrap them however they want:
+
+```
+This is not very pleasant to read because
+the text
+is manually wrapped, but the size of the
+screen is
+smaller than the size the text is wrapped
+at. I
+need to write even more useless text here
+so I get
+my point across. Also hi! If you're here
+that
+means you're either going to contribute to
+Tilde
+Friends, or that you're reviewing my
+stupid
+changes. Either way, you're awesome!
+```
+
+You MAY use one line per sentence.
+
+2. Lines ending with an `inline code block` SHOULD NOT end with a period.
+
+> Example: To build in docker, `docker build .`
+
+NB: this does not apply to file names or other text that are not meant to be copy-pasted.
+
+> Example: this document is named `docs/guidelines/documentation-guidelines.md` instead of `docs/guidelines/documentation.md` because it could cause confusion with `docs/documentation.md`.
+
+More TODO
 
 ## License