From deb4730d40017e28d2ff891ee045e5f0686c47b1 Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoit@matrix.org>
Date: Thu, 24 Nov 2022 16:43:37 +0100
Subject: [PATCH] Add section about knit tool

---
 CONTRIBUTING.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6e3c784dac..62762d7231 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -126,6 +126,23 @@ Note that you can run
 
 For ktlint to fix some detected errors for you (you still have to check and commit the fix of course)
 
+#### knit
+
+[knit](https://github.com/Kotlin/kotlinx-knit) is a tool which checks markdown files on the project. Also it generates/updates the table of content (toc) of the markdown files.
+
+So everytime the toc should be updated, just run
+<pre>
+./gradlew knit
+</pre>
+
+and commit the changes.
+
+The CI will check that markdown files are up to date by running
+
+<pre>
+./gradlew knitCheck
+</pre>
+
 #### lint
 
 <pre>