styling: documentation

templates/documentation/base.html

@@ -9,7 +9,8 @@
       </aside>
       <!-- Main Content -->
 
-      <article class="prose flex mx-auto justify-center flex-col">
+      <article
+        class="prose prose-sm md:prose-base prose-h1:mb-2 prose-h2:my-2 prose-p:my-2 prose-ul:my-2 prose-pre:my-2 flex mx-auto justify-center flex-col">
         {% block article %}
         {% endblock %}
       </article>

templates/documentation/get_started.html

@@ -1,6 +1,6 @@
 {% extends 'documentation/base.html' %}
 {% block article %}
-<h2>Get Started with Minne</h2>
+<h1>Get Started with Minne</h1>
 <p>Minne offers two installation options to suit your needs:</p>
 <ol>
   <li>
@@ -13,7 +13,8 @@
     release, open the <code>config.yaml</code> file and set the following configurations:
   </li>
 </ol>
-<pre><code>
+<pre class="overflow-x-auto text-sm">
+  <code class="break-words whitespace-pre-wrap">
     OPENAI_API_KEY: your_api_key
     SMTP_EMAIL_RELAYER: your_email_relayer
     SMTP_USERNAME: your_smtp_username
@@ -21,7 +22,8 @@
     DB_ADDRESS: your_db_address
     DB_USER: your_db_user
     DB_PASSWORD: your_db_password
-  </code></pre>
+  </code>
+</pre>
 <p>The database settings relate to a running instance of SurrealDB. You can opt for their cloud solution or run your
   own instance.</p>
 
@@ -43,6 +45,7 @@
   via the <code>/admin</code> page if desired.</p>
 
 <p>From the homepage (<code>/</code>), you can:</p>
+
 <ul>
   <li>Submit content, including files, videos, and URLs for ingestion.</li>
   <li>Monitor job statuses and manage your existing content.</li>

templates/documentation/index.html

@@ -1,6 +1,6 @@
 {% extends "documentation/base.html" %}
 {% block article %}
-<h2>Documentation</h2>
+<h1 class="text-3xl mb-2">Documentation</h1>
 <p>
   Personalised Knowledge Management (PKM) is a system designed to help individuals organise, store, and retrieve
   information effectively. It empowers users to create a personalised workflow for managing knowledge, enabling

templates/documentation/privacy.html

@@ -1,30 +1,27 @@
 {% extends 'documentation/base.html' %}
 {% block article %}
-<h2>Privacy Policy</h2>
+<h1>Privacy Policy</h1>
 <p>We value your privacy and are committed to protecting your personal information. This policy
   outlines how we handle your data and ensures transparency in our practices.</p>
 
-<h3>Data Collection</h3>
+<h2>Data Collection</h2>
 <p>We only collect data that is necessary for the functionality of our services. Any data you upload to
   our site remains your property and will not be shared with third parties unless required by law.</p>
 
-<h3>Cookies</h3>
+<h2>Cookies</h2>
 <p>We do not use cookies for tracking or analytics. The cookies we employ are strictly for session
   management, ensuring a smooth and secure user experience.</p>
 
-<h3>No Unnecessary Data Extraction</h3>
+<h2>No Unnecessary Data Extraction</h2>
 <p>We believe that unnecessary data extraction is unethical and a poor practice. We only collect the
   minimum amount of data required to provide our services effectively, ensuring your privacy is respected at all
   times.</p>
 
-<h3>Your Rights</h3>
+<h2>Your Rights</h2>
 <p>You have the right to access, modify, or delete your data at any time. If you have any concerns
   about how your data is handled, please contact us.</p>
 
-<h3>Changes to This Policy</h3>
+<h2>Changes to This Policy</h2>
 <p>We may update this privacy policy from time to time. Any changes will be posted on this page, and we
   encourage you to review it periodically.</p>
-
-<p>Thank you for trusting us with your information. We are committed to treating it with the care and
-  respect it deserves.</p>
 {% endblock %}