From d7eda01c163ab599adcdee476e1dad09e69950f0 Mon Sep 17 00:00:00 2001
From: Tasia Iso <tasiaiso@proton.me>
Date: Sun, 12 May 2024 11:20:09 +0200
Subject: [PATCH] docs: misc

---
 docs/building.md                            |  4 ++--
 docs/contributing.md                        | 10 ++++++++++
 docs/guidelines/documentation-guidelines.md |  8 +++++++-
 docs/in-depth.md                            |  8 +++++++-
 4 files changed, 26 insertions(+), 4 deletions(-)

diff --git a/docs/building.md b/docs/building.md
index 799170ba..da7727a1 100644
--- a/docs/building.md
+++ b/docs/building.md
@@ -45,7 +45,7 @@ Now that you have a binary, head over to <running.md>.
 
 ## Troubleshooting
 
-### The compiler throws an error and I can't build the binary
+### The compiler throws a warning and I can't build the binary
 
 You can choose to tell the compiler to ignore warnings.
 Open `GNUMakefile` and edit the CFLAGS environment variable around line 50.
@@ -75,4 +75,4 @@ CFLAGS += \
 ```
 
 Now the compiler will ignore this error and *should* continue building anyways.
-This is a dirty hack to get Tilde Friends to compile and you should not propose to keep this flag on. Instead, open a bug report.
+Note this is a dirty hack to get Tilde Friends to compile and you should not propose to keep this flag on. Instead, open a bug report.
diff --git a/docs/contributing.md b/docs/contributing.md
index bd4e0592..d48b67ee 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -1,5 +1,15 @@
 # How to contribute
 
+## Philosophy
+
+TODO
+
+## Best practices
+
+TODO
+
+## How to get your changes merged
+
 - Fork this repository
 
 - Clone your repository
diff --git a/docs/guidelines/documentation-guidelines.md b/docs/guidelines/documentation-guidelines.md
index 14394530..8afdf20a 100644
--- a/docs/guidelines/documentation-guidelines.md
+++ b/docs/guidelines/documentation-guidelines.md
@@ -47,7 +47,7 @@ The documentation should therefore be acessible and usefule to most people inter
 
     You MAY use one line per sentence.
 
-2. Lines ending with an `inline code block` SHOULD NOT end with a period to make copy-pasting easier.
+2. Lines ending with an `inline code block` or hyperlinks SHOULD NOT end with a period to make copy-pasting easier.
 
     > Example: To build in docker, `$ docker build .`
 
@@ -67,3 +67,9 @@ More TODO
 ## License
 
 As per the rest of the code in this repository, the documentation is shared under the [MIT](https://opensource.org/licenses/MIT/) license.
+
+## Changelog
+
+### v1 (2024-05-12)
+
+First version; 3 new guidelines.
diff --git a/docs/in-depth.md b/docs/in-depth.md
index 6f4d3c93..102e3e70 100644
--- a/docs/in-depth.md
+++ b/docs/in-depth.md
@@ -1,5 +1,4 @@
 # Tilde Friends in depth
-# Tilde Friends
 
 ## Philosophy
 
@@ -29,3 +28,10 @@ The core process runs a core set of scripts that implement a web server, typical
 Only the core process has access to most system resources, but session processes can be given accesss through the core process.
 
 Service processes are identical to session processes, but they are not tied to a user session.
+
+```text
+/-------\         /-------------\         /--------------\
+| C app | <-----> | Server-side | <-----> | Client-side  |
+|       |  tfrpc  | JS runtime  |         | JS (Browser) |
+\-------/         \-------------/         \--------------/
+```