[proxy] add an index page to the documentation

2 files changed, 65 insertions, 0 deletions

diff --git a/src/hydrilla/proxy/self_doc/doc_index.html.jinja b/src/hydrilla/proxy/self_doc/doc_index.html.jinja
new file mode 100644
index 0000000..03f2231
--- /dev/null
+++ b/src/hydrilla/proxy/self_doc/doc_index.html.jinja
@@ -0,0 +1,59 @@
+{#
+SPDX-License-Identifier: GPL-3.0-or-later OR CC-BY-SA-4.0
+
+Documentation pages index.
+
+This file is part of Hydrilla&Haketilo.
+
+Copyright (C) 2022 Wojtek Kosior
+
+Dual licensed under
+* GNU General Public License v3.0 or later and
+* Creative Commons Attribution Share Alike 4.0 International.
+
+You can choose to use either of these licenses or both.
+
+
+I, Wojtek Kosior, thereby promise not to sue for violation of this
+file's licenses. Although I request that you do not make use of this
+code in a proprietary work, I am not going to enforce this in court.
+#}
+{% extends "doc_base.html.jinja" %}
+
+{% block title %} Documentation index {% endblock %}
+
+{% block main %}
+  {{ big_heading('Haketilo embedded documentation') }}
+
+  {% call section() %}
+    {% call paragraph() %}
+      This is the embedded documentation of Haketilo proxy.
+      It contains some basic information aimed to help new users understand how
+      the tool works.
+    {% endcall %}
+
+    {% call unordered_list() %}
+      {% call list_entry() %}
+        {{ doc_page_link('Advanced UI features', 'advanced_ui_features') }}
+      {% endcall %}
+      {% call list_entry() %}
+        {{ doc_page_link('Packages', 'packages') }}
+      {% endcall %}
+      {% call list_entry() %}
+        {{ doc_page_link('Policy selection', 'policy_selection') }}
+      {% endcall %}
+      {% call list_entry() %}
+        {{ doc_page_link('Popup', 'popup') }}
+      {% endcall %}
+      {% call list_entry() %}
+        {{ doc_page_link('Repositories', 'repositories') }}
+      {% endcall %}
+      {% call list_entry() %}
+        {{ doc_page_link('Script blocking', 'script_blocking') }}
+      {% endcall %}
+      {% call list_entry() %}
+        {{ doc_page_link('URL patterns', 'url_patterns') }}
+      {% endcall %}
+    {% endcall %}
+  {% endcall %}
+{% endblock main %}
diff --git a/src/hydrilla/proxy/web_ui/templates/index.html.jinja b/src/hydrilla/proxy/web_ui/templates/index.html.jinja
index 25649ff..1e498a3 100644
--- a/src/hydrilla/proxy/web_ui/templates/index.html.jinja
+++ b/src/hydrilla/proxy/web_ui/templates/index.html.jinja
@@ -49,6 +49,12 @@ code in a proprietary work, I am not going to enforce this in court.
     {{ _('web_ui.home.html.haketilo_is_blah_blah')|safe }}
   </p>
 
+  <p class="has-colored-links">
+    {% set fmt = _('web_ui.home.html.see_haketilo_doc_{url}') %}
+    {% set doc_url = url_for('home.home_doc', page='doc_index') %}
+    {{ fmt.format(url=doc_url|e)|safe }}
+  </p>
+
   <div class="horizontal-separator"></div>
 
   {% if request.url.startswith('http://') %}