From b6835d51a215cc477339f36fe6aff8994bf49dd4 Mon Sep 17 00:00:00 2001
From: moisseev <moiseev@mezonplus.ru>
Date: Thu, 11 Apr 2024 15:24:42 +0300
Subject: [PATCH 01/10] Add parameters to directory tree generator

---
 _includes/directory-tree.html | 113 ++++++++++++++++++++++++++++------
 sitemap.md                    |   3 +-
 2 files changed, 95 insertions(+), 21 deletions(-)

diff --git a/_includes/directory-tree.html b/_includes/directory-tree.html
index 11fd9aeec..9ca050662 100644
--- a/_includes/directory-tree.html
+++ b/_includes/directory-tree.html
@@ -1,13 +1,61 @@
-<ul>
-  {%- assign sorted_pages = include.pages | sort: "dir" -%}
-  {%- for page in sorted_pages -%}
-    {%- if page.layout == nil or page.layout == 'none' or page.dir contains '/blog/page' -%}
+{%- comment -%}
+Build a directory tree (e.g. sitemap)
+
+Page Front Matter directory-tree hash parameters:
+
+  emphasize     Emphasize the page in the tree.
+                Default: false.
+
+  de-emphasize  De-emphasize the page in the tree.
+                Default: false.
+
+Tree include parameters:
+
+  dir           The top-level directory of the tree.
+                If the path ends with a slash, the directory itself will be excluded from the tree.
+                Default: The root directory.
+
+Tree parameters that can be passed as include hash, Front Matter directory-tree hash or Liquid variables with directory-tree- prefix:
+
+  li            The generated tree is a list item. Do not wrap an <ul> tag around it.
+
+  dir_class     Add a class attribute with the specified classes to <li> tags of all directories.
+                If not set, wrap a <strong> tag around titles of all directories.
+
+  strong        Wrap a <strong> tag around titles of the pages that have set `emphasize: true` in the Front Matter.
+                Default: false.
+
+  del           Wrap a <del> tag around titles of the pages that have set `de-emphasize: true` in the Front Matter.
+                Default: false.
+{%- endcomment -%}
+{%- unless include.li or page.directory-tree.li or directory-tree-li %}<ul>{%- endunless %}
+  {%- assign dir_class = include.dir_class | default: directory-tree-dir_class | default: page.directory-tree.dir_class -%}
+  {%- if dir_class -%}
+    {%- assign dir_li = '<li class="' | append:  dir_class | append: '">' -%}
+  {%- else -%}
+    {%- assign dir_li = "<li>" -%}
+    {%- assign dir_strong = "<strong>" -%}
+    {%- assign dir_strong_closing = "</strong>" -%}
+  {%- endif -%}
+  {%- assign prev_page_dir = include.dir -%}
+  {%- assign sorted_pages = site.pages | sort: "dir" -%}
+  {%- for pg in sorted_pages -%}
+    {%- comment -%}
+    # Skip page unless its directory starts with include.dir.
+    {%- endcomment -%}
+    {%- if include.dir -%}
+      {%- assign check_str = pg.dir | split: include.dir | first -%}
+      {%- if check_str.size > 0 -%}
+        {%- continue -%}
+      {%- endif -%}
+    {%- endif -%}
+    {%- if pg.layout == nil or pg.layout == 'none' or pg.dir contains '/blog/page' -%}
       {%- continue -%}
     {%- endif -%}
-    {% unless page.dir == prev_page_dir -%}
-        {%- assign path = page.dir | split: "/" -%}
+    {% unless pg.dir == prev_page_dir -%}
+        {%- assign path = pg.dir | split: "/" -%}
         {%- comment -%}
-        # Split returns [] for "/" but ["", "doc"] "/doc/" as removes empty strings.
+        # Split returns [] for "/" but ["", "doc"] "/doc/" as removes trailing empty strings.
         {%- endcomment -%}
         {%- unless path.size > 0 -%}
           {%- assign path = path | push: "" -%}
@@ -30,28 +78,55 @@
             {%- assign levels_match = index0 -%}
             {%- break -%}
           {%- endunless -%}
+          {%- if forloop.last -%}
+            {%- assign levels_match = forloop.index0 -%}
+          {%- endif -%}
         {%- endfor -%}
         {%- for num in (1..levels_back) %}
     </ul>
   </li>
         {%- endfor -%}
-      {% for dir in path offset:levels_match -%}
-        {%- assign dir_index_page = include.pages | where: "dir", page.dir | where: "name", "index.md" | first -%}
-        {%- unless dir_index_page -%}
-          {%- assign dir_index_page = include.pages | where: "dir", page.dir | where: "name", "index.html" | first -%}
-        {%- endunless %}
-  <li>
-    <a href="{{ site.baseurl }}{{ page.dir }}"><strong>{{ dir_index_page.title }}</strong></a>
+      {% for dir in path offset:levels_match %}
+  {{ dir_li }}
+        {%- if forloop.last -%}
+          {%- assign dir_pages = site.pages | where: "dir", pg.dir -%}
+          {%- assign dir_index_page = dir_pages | where: "name", "index.md" | first -%}
+          {%- unless dir_index_page -%}
+            {%- assign dir_index_page = dir_pages | where: "name", "index.html" | first -%}
+          {%- endunless %}
+    <a href="{{ site.baseurl }}{{ pg.dir }}">{{ dir_strong }}{{ dir_index_page.title }}{{ dir_strong_closing }}</a>
+        {%- else %}
+    {{ dir_strong }}{{ dir }}{{ dir_strong_closing }}
+        {%- endif %}
     <ul>
       {%- endfor %}
-      {%- assign prev_page_dir = page.dir -%}
+      {%- assign prev_page_dir = pg.dir -%}
     {%- endunless %}
-    {%- unless page.name == "index.md" or page.name == "index.html" %}
-      <li><a href="{{ site.baseurl }}{{ page.url }}">{{ page.title }}</a></li>
+    {%- unless pg.name == "index.md" or pg.name == "index.html" -%}
+      {%- if pg.directory-tree.emphasize and include.strong or page.directory-tree.strong or directory-tree-strong -%}
+        {%- assign strong = "<strong>" -%}
+        {%- assign strong_closing = "</strong>" -%}
+      {%- else -%}
+        {%- assign strong = "" -%}
+        {%- assign strong_closing = "" -%}
+      {%- endif -%}
+      {%- if pg.directory-tree.de-emphasize and include.del or page.directory-tree.del or directory-tree-del -%}
+        {%- assign del = "<del>" -%}
+        {%- assign del_closing = "</del>" -%}
+      {%- else -%}
+        {%- assign del = "" -%}
+        {%- assign del_closing = "" -%}
+      {%- endif %}
+      <li><a href="{{ site.baseurl }}{{ pg.url }}">{{ strong }}{{ del }}{{ pg.title }}{{ del_closing }}{{ strong_closing }}</a></li>
     {%- endunless -%}
   {% endfor -%}
-  {%- for dir in path %}
+  {%- assign offset = include.dir | split: "/" | size -%}
+  {%- assign last_char = include.dir | slice: -1 -%}
+  {%- unless last_char == "/" -%}
+    {%- assign offset = offset | minus: 1 -%}
+  {%- endunless -%}
+  {%- for dir in path offset: offset %}
     </ul>
   </li>
   {%- endfor %}
-</ul>
+{% unless include.li or page.directory-tree.li  or directory-tree-li -%}</ul>{%- endunless -%}
diff --git a/sitemap.md b/sitemap.md
index bde59db04..612d28104 100644
--- a/sitemap.md
+++ b/sitemap.md
@@ -9,8 +9,7 @@ title: Site map
   <div class="col-md">
     <h2 class="mt-3">Pages</h2>
 
-{% include directory-tree.html
-  pages=site.pages %}
+{% include directory-tree.html %}
 
   </div>
   <div class="col-md">

From 604bdc27a6318bf7fbd7a8f9f10aaf6fa5939fd9 Mon Sep 17 00:00:00 2001
From: moisseev <moiseev@mezonplus.ru>
Date: Fri, 12 Apr 2024 10:53:24 +0300
Subject: [PATCH 02/10] Generate Modules documentation section

---
 _layouts/doc.html | 53 +++++------------------------------------------
 1 file changed, 5 insertions(+), 48 deletions(-)

diff --git a/_layouts/doc.html b/_layouts/doc.html
index 8153750d2..7118bdc81 100644
--- a/_layouts/doc.html
+++ b/_layouts/doc.html
@@ -1,6 +1,10 @@
 <!-- remove the white space after footer-->
 {% include top.html %}
 
+{%- assign directory-tree-li = true -%}
+{%- assign directory-tree-strong = true -%}
+{%- assign directory-tree-dir_class = "r-docs-subnav list-group-item" %}
+
 <style>
 	.r-docs-nav {
 		width: 300px;
@@ -107,54 +111,7 @@
 				</ul>
 			</li>
 
-			<li class="r-docs-subnav list-group-item">
-				<a href="{{ site.baseurl }}/doc/modules/">Modules documentation</a>
-				<ul>
-					<li><a href="{{ site.baseurl }}/doc/modules/antivirus.html"><strong>Antivirus</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/arc.html">ARC module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/asn.html">ASN module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/bayes_expiry.html">Bayes expiry module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/clickhouse.html"><strong>Clickhouse module</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/chartable.html">Chartable</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/dcc.html">DCC module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/dkim.html">DKIM</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/dkim_signing.html">DKIM signing</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/dmarc.html">DMARC</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/elastic.html">Elasticsearch exporter</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/emails.html">Emails scan</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/external_relay.html">External relay</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/external_services.html"><strong>External services</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/force_actions.html"><strong>Force Actions</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/fuzzy_check.html">Fuzzy check</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/greylisting.html">Greylisting module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/hfilter.html">Hfilter</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/history_redis.html">History redis module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/known_senders.html">Known senders module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/maillist.html">Mailing list</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/metadata_exporter.html">Metadata exporter</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/metric_exporter.html">Metric exporter</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/mid.html">MID module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/milter_headers.html"><strong>Milter headers</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/mime_types.html">Mime types</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/multimap.html"><strong>Multimap</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/mx_check.html">MX Check</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/neural.html">Neural network module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/phishing.html">Phishing check</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/ratelimit.html"><strong>Ratelimit</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/rbl.html"><strong>RBL</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/regexp.html"><strong>Regexp</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/reputation.html">Reputation</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/once_received.html">Received policy</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/replies.html">Replies module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/rspamd_update.html">Rspamd update</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/spamassassin.html">Spamassassin rules</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/spamtrap.html">Spamtrap</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/spf.html">SPF</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/trie.html">Trie matcher</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/url_redirector.html">URL redirector</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/whitelist.html">Whitelist</a></li>
-				</ul>
-			</li>
+			{% include directory-tree.html dir="/doc/modules" %}
 
 			<li class="r-docs-subnav list-group-item">
 				<a href="{{ site.baseurl }}/doc/workers/">Workers documentation</a>

From 1a4c090bc005c47811685e3217f07e9899c0744e Mon Sep 17 00:00:00 2001
From: moisseev <moiseev@mezonplus.ru>
Date: Sun, 14 Apr 2024 17:08:12 +0300
Subject: [PATCH 03/10] Emphasize some modules

---
 doc/modules/antivirus.md         | 2 ++
 doc/modules/clickhouse.md        | 2 ++
 doc/modules/external_services.md | 2 ++
 doc/modules/force_actions.md     | 2 ++
 doc/modules/milter_headers.md    | 2 ++
 doc/modules/multimap.md          | 2 ++
 doc/modules/ratelimit.md         | 2 ++
 doc/modules/rbl.md               | 2 ++
 doc/modules/regexp.md            | 2 ++
 9 files changed, 18 insertions(+)

diff --git a/doc/modules/antivirus.md b/doc/modules/antivirus.md
index e5744d869..301ded7d5 100644
--- a/doc/modules/antivirus.md
+++ b/doc/modules/antivirus.md
@@ -1,6 +1,8 @@
 ---
 layout: doc
 title: Antivirus module
+directory-tree:
+  emphasize: true
 ---
 
 # Antivirus module
diff --git a/doc/modules/clickhouse.md b/doc/modules/clickhouse.md
index df650970f..27957c93f 100644
--- a/doc/modules/clickhouse.md
+++ b/doc/modules/clickhouse.md
@@ -1,6 +1,8 @@
 ---
 layout: doc
 title: Clickhouse module
+directory-tree:
+  emphasize: true
 ---
 
 # Clickhouse module
diff --git a/doc/modules/external_services.md b/doc/modules/external_services.md
index a0bda96ef..274634297 100644
--- a/doc/modules/external_services.md
+++ b/doc/modules/external_services.md
@@ -1,6 +1,8 @@
 ---
 layout: doc
 title: External Services module
+directory-tree:
+  emphasize: true
 ---
 
 # External Services module
diff --git a/doc/modules/force_actions.md b/doc/modules/force_actions.md
index c2c16c775..794fc35ee 100644
--- a/doc/modules/force_actions.md
+++ b/doc/modules/force_actions.md
@@ -1,6 +1,8 @@
 ---
 layout: doc
 title: Force Actions module
+directory-tree:
+  emphasize: true
 ---
 
 # Force Actions module
diff --git a/doc/modules/milter_headers.md b/doc/modules/milter_headers.md
index 033ea5d8a..0b7435d31 100644
--- a/doc/modules/milter_headers.md
+++ b/doc/modules/milter_headers.md
@@ -1,6 +1,8 @@
 ---
 layout: doc
 title: Milter headers module
+directory-tree:
+  emphasize: true
 ---
 
 # Milter headers module
diff --git a/doc/modules/multimap.md b/doc/modules/multimap.md
index ecd33c336..aa3d53f35 100644
--- a/doc/modules/multimap.md
+++ b/doc/modules/multimap.md
@@ -1,6 +1,8 @@
 ---
 layout: doc
 title: Multimap module
+directory-tree:
+  emphasize: true
 ---
 # Multimap module
 {:.no_toc}
diff --git a/doc/modules/ratelimit.md b/doc/modules/ratelimit.md
index 056aceb96..1173b7891 100644
--- a/doc/modules/ratelimit.md
+++ b/doc/modules/ratelimit.md
@@ -1,6 +1,8 @@
 ---
 layout: doc
 title: Ratelimit module
+directory-tree:
+  emphasize: true
 ---
 
 # Ratelimit plugin
diff --git a/doc/modules/rbl.md b/doc/modules/rbl.md
index 4910d75a0..4703daa31 100644
--- a/doc/modules/rbl.md
+++ b/doc/modules/rbl.md
@@ -1,6 +1,8 @@
 ---
 layout: doc
 title: RBL module
+directory-tree:
+  emphasize: true
 ---
 # RBL module
 {:.no_toc}
diff --git a/doc/modules/regexp.md b/doc/modules/regexp.md
index d235c792f..efca5278e 100644
--- a/doc/modules/regexp.md
+++ b/doc/modules/regexp.md
@@ -1,6 +1,8 @@
 ---
 layout: doc
 title: Regexp module
+directory-tree:
+  emphasize: true
 ---
 
 # Rspamd regexp module

From a2a0513a57976d90d2dbcaf8111ff3f7847d2472 Mon Sep 17 00:00:00 2001
From: moisseev <moiseev@mezonplus.ru>
Date: Sat, 13 Apr 2024 19:47:48 +0300
Subject: [PATCH 04/10] Cross-out deprecated modules

---
 _layouts/doc.html       | 2 ++
 doc/modules/emails.md   | 2 ++
 doc/modules/ip_score.md | 2 ++
 doc/modules/surbl.md    | 2 ++
 doc/modules/trie.md     | 2 ++
 5 files changed, 10 insertions(+)

diff --git a/_layouts/doc.html b/_layouts/doc.html
index 7118bdc81..3533022ef 100644
--- a/_layouts/doc.html
+++ b/_layouts/doc.html
@@ -3,6 +3,7 @@
 
 {%- assign directory-tree-li = true -%}
 {%- assign directory-tree-strong = true -%}
+{%- assign directory-tree-del = true -%}
 {%- assign directory-tree-dir_class = "r-docs-subnav list-group-item" %}
 
 <style>
@@ -22,6 +23,7 @@
 		font-weight: bold;
 		color: #de4700;
 	}
+	.r-docs-nav a:not(.active-link) > del { opacity: 0.4; }
 
 	.r-docs-subnav ul {
 		list-style: none;
diff --git a/doc/modules/emails.md b/doc/modules/emails.md
index fab96700e..8423ca9f2 100644
--- a/doc/modules/emails.md
+++ b/doc/modules/emails.md
@@ -1,6 +1,8 @@
 ---
 layout: doc
 title: Emails module
+directory-tree:
+  de-emphasize: true
 ---
 
 # Emails module
diff --git a/doc/modules/ip_score.md b/doc/modules/ip_score.md
index f1f45866f..f294dc3fa 100644
--- a/doc/modules/ip_score.md
+++ b/doc/modules/ip_score.md
@@ -1,6 +1,8 @@
 ---
 layout: doc
 title: IP Score module
+directory-tree:
+  de-emphasize: true
 ---
 
 # IP Score
diff --git a/doc/modules/surbl.md b/doc/modules/surbl.md
index 8f27d633e..d85ad2eec 100644
--- a/doc/modules/surbl.md
+++ b/doc/modules/surbl.md
@@ -1,6 +1,8 @@
 ---
 layout: doc
 title: SURBL module
+directory-tree:
+  de-emphasize: true
 ---
 
 # SURBL module
diff --git a/doc/modules/trie.md b/doc/modules/trie.md
index 1f1450f72..ffabcec6e 100644
--- a/doc/modules/trie.md
+++ b/doc/modules/trie.md
@@ -1,6 +1,8 @@
 ---
 layout: doc
 title: Trie module
+directory-tree:
+  de-emphasize: true
 ---
 
 # Trie plugin

From 1574ab369c90894bad80b6de9b23cf26c83cf2e3 Mon Sep 17 00:00:00 2001
From: moisseev <moiseev@mezonplus.ru>
Date: Sat, 13 Apr 2024 18:13:01 +0300
Subject: [PATCH 05/10] Fix module page titles

---
 doc/modules/rspamd_update.md | 2 +-
 doc/modules/spamassassin.md  | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/modules/rspamd_update.md b/doc/modules/rspamd_update.md
index 02b26470a..74cd121cf 100644
--- a/doc/modules/rspamd_update.md
+++ b/doc/modules/rspamd_update.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Rspamd updates module
+title: Rspamd update module
 ---
 # Rspamd update module
 
diff --git a/doc/modules/spamassassin.md b/doc/modules/spamassassin.md
index ad9a4cc42..ea4000d16 100644
--- a/doc/modules/spamassassin.md
+++ b/doc/modules/spamassassin.md
@@ -1,8 +1,8 @@
 ---
 layout: doc
-title: Spamassassin module
+title: SpamAssassin rules module
 ---
-# Spamassassin rules module
+# SpamAssassin rules module
 
 This module is intended to enable the adoption and reading of SpamAssassin rules within Rspamd.
 

From 91e80133867ea8e99b3b43bbfcd85aa4d36247ec Mon Sep 17 00:00:00 2001
From: moisseev <moiseev@mezonplus.ru>
Date: Sun, 14 Apr 2024 17:51:23 +0300
Subject: [PATCH 06/10] Generate configuration and workers sections

---
 _layouts/doc.html | 28 ++--------------------------
 1 file changed, 2 insertions(+), 26 deletions(-)

diff --git a/_layouts/doc.html b/_layouts/doc.html
index 3533022ef..97c3cad3d 100644
--- a/_layouts/doc.html
+++ b/_layouts/doc.html
@@ -97,33 +97,9 @@
 				<a href="{{ site.baseurl }}/doc/faq.html">FAQ</a>
 			</li>
 
-			<li class="r-docs-subnav list-group-item">
-				<a href="{{ site.baseurl }}/doc/configuration/index.html">Rspamd configuration</a>
-				<ul>
-					<li><a href="{{ site.baseurl }}/doc/configuration/ucl.html">Universal configuration language (UCL)</a></li>
-					<li><a href="{{ site.baseurl }}/doc/configuration/composites.html">Composite symbols</a></li>
-					<li><a href="{{ site.baseurl }}/doc/configuration/logging.html">Logging setup</a></li>
-					<li><a href="{{ site.baseurl }}/doc/configuration/metrics.html">Symbols scores and metrics setup</a></li>
-					<li><a href="{{ site.baseurl }}/doc/configuration/options.html">Common options</a></li>
-					<li><a href="{{ site.baseurl }}/doc/configuration/redis.html">Redis server setup</a></li>
-					<li><a href="{{ site.baseurl }}/doc/configuration/statistic.html">Statistical module setup</a></li>
-					<li><a href="{{ site.baseurl }}/doc/configuration/settings.html">Users settings</a></li>
-					<li><a href="{{ site.baseurl }}/doc/configuration/upstream.html">Upstreams setup</a></li>
-					<li><a href="{{ site.baseurl }}/doc/configuration/selectors.html">Selectors</a></li>
-				</ul>
-			</li>
-
+			{% include directory-tree.html dir="/doc/configuration" %}
 			{% include directory-tree.html dir="/doc/modules" %}
-
-			<li class="r-docs-subnav list-group-item">
-				<a href="{{ site.baseurl }}/doc/workers/">Workers documentation</a>
-				<ul>
-					<li><a href="{{ site.baseurl }}/doc/workers/normal.html">Normal worker (scanner)</a></li>
-					<li><a href="{{ site.baseurl }}/doc/workers/rspamd_proxy.html">Proxy worker</a></li>
-					<li><a href="{{ site.baseurl }}/doc/workers/controller.html">Controller worker</a></li>
-					<li><a href="{{ site.baseurl }}/doc/workers/fuzzy_storage.html">Fuzzy hashes storage</a></li>
-				</ul>
-			</li>
+			{% include directory-tree.html dir="/doc/workers" %}
 
 			<li class="r-docs-subnav list-group-item">
 				<a href="#">Developers documentation</a>

From acea616ce6b6da1654efb96b1250c2a21237496d Mon Sep 17 00:00:00 2001
From: moisseev <moiseev@mezonplus.ru>
Date: Sun, 14 Apr 2024 18:07:34 +0300
Subject: [PATCH 07/10] Fix configuration and workers page titles

---
 doc/configuration/composites.md | 2 +-
 doc/configuration/logging.md    | 2 +-
 doc/configuration/metrics.md    | 2 +-
 doc/configuration/options.md    | 2 +-
 doc/configuration/selectors.md  | 2 +-
 doc/configuration/settings.md   | 2 +-
 doc/configuration/statistic.md  | 2 +-
 doc/configuration/ucl.md        | 2 +-
 doc/workers/normal.md           | 2 +-
 doc/workers/rspamd_proxy.md     | 2 +-
 10 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/doc/configuration/composites.md b/doc/configuration/composites.md
index 6c855d3f1..45e3b991e 100644
--- a/doc/configuration/composites.md
+++ b/doc/configuration/composites.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Rspamd Composites
+title: Composite symbols
 ---
 
 # Rspamd composite symbols
diff --git a/doc/configuration/logging.md b/doc/configuration/logging.md
index a8181eb04..ee4a5473c 100644
--- a/doc/configuration/logging.md
+++ b/doc/configuration/logging.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Rspamd Logging
+title: Logging settings
 ---
 
 # Rspamd logging settings
diff --git a/doc/configuration/metrics.md b/doc/configuration/metrics.md
index abb604cf4..63258321f 100644
--- a/doc/configuration/metrics.md
+++ b/doc/configuration/metrics.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Rspamd Metrics
+title: Actions and scores
 ---
 # Rspamd actions and scores
 
diff --git a/doc/configuration/options.md b/doc/configuration/options.md
index c60ef4b70..85b01a6cc 100644
--- a/doc/configuration/options.md
+++ b/doc/configuration/options.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Rspamd Options
+title: Common options
 ---
 # Rspamd options settings
 
diff --git a/doc/configuration/selectors.md b/doc/configuration/selectors.md
index d7682de6f..3b6418fff 100644
--- a/doc/configuration/selectors.md
+++ b/doc/configuration/selectors.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Rspamd Selectors
+title: Selectors
 ---
 
 # Rspamd selectors settings
diff --git a/doc/configuration/settings.md b/doc/configuration/settings.md
index 5b2eb7704..a94f4542e 100644
--- a/doc/configuration/settings.md
+++ b/doc/configuration/settings.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Users settings description
+title: User settings
 ---
 # Rspamd user settings
 
diff --git a/doc/configuration/statistic.md b/doc/configuration/statistic.md
index 8574caea4..fdee6aefd 100644
--- a/doc/configuration/statistic.md
+++ b/doc/configuration/statistic.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Rspamd Statistics
+title: Statistics settings
 ---
 # Rspamd statistic settings
 
diff --git a/doc/configuration/ucl.md b/doc/configuration/ucl.md
index 54cd5fa2b..2762331bd 100644
--- a/doc/configuration/ucl.md
+++ b/doc/configuration/ucl.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: UCL language
+title: Universal configuration language (UCL)
 ---
 # UCL configuration language
 
diff --git a/doc/workers/normal.md b/doc/workers/normal.md
index e4bf09532..7a0968aad 100644
--- a/doc/workers/normal.md
+++ b/doc/workers/normal.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Rspamd normal worker
+title: Normal worker (scanner)
 ---
 # Rspamd normal worker
 
diff --git a/doc/workers/rspamd_proxy.md b/doc/workers/rspamd_proxy.md
index bf173d5c5..d09c441b6 100644
--- a/doc/workers/rspamd_proxy.md
+++ b/doc/workers/rspamd_proxy.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Rspamd proxy worker
+title: Proxy worker
 ---
 
 # Rspamd proxy worker

From 1250976395f1987e652fce5c02e7e0a24c20a422 Mon Sep 17 00:00:00 2001
From: moisseev <moiseev@mezonplus.ru>
Date: Mon, 15 Apr 2024 12:46:24 +0300
Subject: [PATCH 08/10] Move pages filtering in a separate loop

---
 _includes/directory-tree.html | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/_includes/directory-tree.html b/_includes/directory-tree.html
index 9ca050662..ad585e3d8 100644
--- a/_includes/directory-tree.html
+++ b/_includes/directory-tree.html
@@ -38,8 +38,8 @@
     {%- assign dir_strong_closing = "</strong>" -%}
   {%- endif -%}
   {%- assign prev_page_dir = include.dir -%}
-  {%- assign sorted_pages = site.pages | sort: "dir" -%}
-  {%- for pg in sorted_pages -%}
+  {%- assign filtered_pages = "" | split: "," -%}
+  {%- for pg in site.pages -%}
     {%- comment -%}
     # Skip page unless its directory starts with include.dir.
     {%- endcomment -%}
@@ -52,6 +52,10 @@
     {%- if pg.layout == nil or pg.layout == 'none' or pg.dir contains '/blog/page' -%}
       {%- continue -%}
     {%- endif -%}
+    {%- assign filtered_pages = filtered_pages | push: pg -%}
+  {%- endfor -%}
+  {%- assign sorted_pages = filtered_pages | sort: "dir" -%}
+  {%- for pg in sorted_pages -%}
     {% unless pg.dir == prev_page_dir -%}
         {%- assign path = pg.dir | split: "/" -%}
         {%- comment -%}

From 704a236d87f871e0392d619161db0e5764729902 Mon Sep 17 00:00:00 2001
From: moisseev <moiseev@mezonplus.ru>
Date: Mon, 15 Apr 2024 13:22:25 +0300
Subject: [PATCH 09/10] Sort subdirectories

---
 _includes/directory-tree.html | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/_includes/directory-tree.html b/_includes/directory-tree.html
index ad585e3d8..a3b151a3f 100644
--- a/_includes/directory-tree.html
+++ b/_includes/directory-tree.html
@@ -37,7 +37,6 @@
     {%- assign dir_strong = "<strong>" -%}
     {%- assign dir_strong_closing = "</strong>" -%}
   {%- endif -%}
-  {%- assign prev_page_dir = include.dir -%}
   {%- assign filtered_pages = "" | split: "," -%}
   {%- for pg in site.pages -%}
     {%- comment -%}
@@ -54,7 +53,25 @@
     {%- endif -%}
     {%- assign filtered_pages = filtered_pages | push: pg -%}
   {%- endfor -%}
-  {%- assign sorted_pages = filtered_pages | sort: "dir" -%}
+  {%- assign sorted_by_dir = filtered_pages | sort_natural: "dir" -%}
+  {%- assign subdir_pages = "" | split: "," -%}
+  {%- assign sorted_pages = "" | split: "," -%}
+  {%- for pg in sorted_by_dir -%}
+    {%- unless pg.dir == prev_page_dir -%}
+      {%- if subdir_pages.size > 0 -%}
+        {%- assign sorted_subdir_pages = subdir_pages | sort_natural: "title" -%}
+        {%- assign sorted_pages = sorted_pages | concat: sorted_subdir_pages -%}
+      {%- endif -%}
+      {%- assign subdir_pages = "" | split: "," -%}
+      {%- assign prev_page_dir = pg.dir -%}
+    {%- endunless -%}
+    {%- assign subdir_pages = subdir_pages | push: pg -%}
+  {%- endfor -%}
+  {%- if subdir_pages.size > 0 -%}
+    {%- assign sorted_subdir_pages = subdir_pages | sort_natural: "title" -%}
+    {%- assign sorted_pages = sorted_pages | concat: sorted_subdir_pages -%}
+  {%- endif -%}
+  {%- assign prev_page_dir = include.dir -%}
   {%- for pg in sorted_pages -%}
     {% unless pg.dir == prev_page_dir -%}
         {%- assign path = pg.dir | split: "/" -%}

From 1a5ae2fbd11b26da84c6b2055be65634e857d136 Mon Sep 17 00:00:00 2001
From: moisseev <moiseev@mezonplus.ru>
Date: Tue, 23 Apr 2024 16:32:30 +0300
Subject: [PATCH 10/10] Remove TODOs

---
 doc/modules/forged_recipients.md | 6 ------
 doc/modules/multimap.md          | 3 ---
 doc/workers/lua_worker.md        | 7 -------
 3 files changed, 16 deletions(-)
 delete mode 100644 doc/modules/forged_recipients.md
 delete mode 100644 doc/workers/lua_worker.md

diff --git a/doc/modules/forged_recipients.md b/doc/modules/forged_recipients.md
deleted file mode 100644
index 47cb3418c..000000000
--- a/doc/modules/forged_recipients.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-layout: doc
-title: Forged recipients module
----
-
-TODO
diff --git a/doc/modules/multimap.md b/doc/modules/multimap.md
index aa3d53f35..2455b8b60 100644
--- a/doc/modules/multimap.md
+++ b/doc/modules/multimap.md
@@ -470,9 +470,6 @@ Combined maps support merely **selectors** syntax, not general multimap rules.
 
 Version 2.0 introduces the capability to create dependent maps in Redis, where the map key is dependent on some other data extracted from the same message. This allows for the creation of per-user based whitelists, among other use cases.
 
-TODO: write more
-
-
 ## Examples
 
 Here are some examples of multimap configurations:
diff --git a/doc/workers/lua_worker.md b/doc/workers/lua_worker.md
deleted file mode 100644
index e70a3bf1e..000000000
--- a/doc/workers/lua_worker.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-layout: doc
-title: Lua worker
----
-# Lua worker
-
-TODO