doc: Add a section dedicated to use cases, so that it is easier to fi…

…nd when reading the documentation
clk-project · Sep 26, 2023 · 1663d94 · 1663d94
1 parent 3440a43
commit 1663d94
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,4 @@
+- [Use cases](#d7cb0451-bc8f-42cc-912c-8a46599375a7)
 - [In a nutshell](#fe60735c-91c2-4f54-8ae2-7e3b307f27a5)
 - [Rationale](#7857f3bb-e4c7-4bad-9e27-ea48bf808a44)
 - [Note on version](#8152d0c9-564d-4761-a847-66a40e41aac5)
@@ -32,6 +33,13 @@ clk, the **Command Line Kit** is a unique tool that aims to contains everything
 The [rationale](#7857f3bb-e4c7-4bad-9e27-ea48bf808a44) attempts to explain why clk started to exist. You will find in the [use cases](./doc/use_cases) classical situations where clk is worth being used. In the future, we might write even more [documentation](./doc).
 
 
+<a id="d7cb0451-bc8f-42cc-912c-8a46599375a7"></a>
+
+# Use cases
+
+This is most likely the most useful part of the documentation. Take a look at the [use cases](./doc/use_cases) to find out how clk could be used in real life situations.
+
+
 <a id="fe60735c-91c2-4f54-8ae2-7e3b307f27a5"></a>
 
 # In a nutshell

diff --git a/README.org b/README.org
@@ -39,6 +39,13 @@ The [[id:7857f3bb-e4c7-4bad-9e27-ea48bf808a44][rationale]] attempts to explain w
 [[./doc/use_cases][use cases]] classical situations where clk is worth being used. In the future, we
 might write even more [[./doc][documentation]].
 
+* Use cases
+  :PROPERTIES:
+  :CUSTOM_ID: d7cb0451-bc8f-42cc-912c-8a46599375a7
+  :END:
+  This is most likely the most useful part of the documentation. Take a look at
+  the [[./doc/use_cases][use cases]] to find out how clk could be used in real life situations.
+
 * In a nutshell                                                     :Context:
   :PROPERTIES:
   :CUSTOM_ID: fe60735c-91c2-4f54-8ae2-7e3b307f27a5