feat: release build bundles templates in bin

crates/html-router/templates/documentation/base.html

@@ -0,0 +1,20 @@
+{% extends "body_base.html" %}
+{% block main %}
+<main class="flex justify-center grow mt-2 sm:mt-4 pb-10">
+  <div class="container">
+    <div class="grid grid-cols-1 lg:grid-cols-[auto_1fr] gap-4">
+      <!-- Documentation Menu -->
+      <aside class="bg-base-200 rounded-lg p-4">
+        {% include "documentation/menu.html" %}
+      </aside>
+      <!-- Main Content -->
+
+      <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>
+    </div>
+  </div>
+</main>
+{% endblock %}

crates/html-router/templates/documentation/get_started.html

@@ -0,0 +1,58 @@
+{% extends 'documentation/base.html' %}
+{% block article %}
+<h1>Get Started with Minne</h1>
+<p>Minne offers two installation options to suit your needs:</p>
+<ol>
+  <li>
+    <strong>Hosted Version:</strong> Enjoy a hassle‐free experience by signing up for the ready‐to‐use service.
+    Simply navigate to <code>/signup</code> to create an account.
+  </li>
+  <li>
+    <strong>Self-Hosted:</strong> Gain full control by running Minne on your own infrastructure. Visit
+    <a href="https://github.com/perstarkse/minne">GitHub</a> to download the latest release. After extracting the
+    release, open the <code>config.yaml</code> file and set the following configurations:
+  </li>
+</ol>
+<pre class="overflow-x-auto text-sm">
+  <code class="break-words whitespace-pre-wrap">
+    OPENAI_API_KEY: your_api_key
+    DB_ADDRESS: your_db_address
+    DB_USER: your_db_user
+    DB_PASSWORD: your_db_password
+  </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>
+
+<p>Once your configuration is complete, start both the server and the worker. They can be hosted on separate
+  machines, with different resource requirements:</p>
+<ul>
+  <li>
+    <strong>Server:</strong> Lightweight. A minimum of 1 core and 256MB of RAM is recommended.
+  </li>
+  <li>
+    <strong>Worker:</strong> Handles content parsing and creation of database entities. It's recommended to allocate at
+    least two cores and 1024 MB RAM. It will run on less but might run into constraints depending on the content being
+    parsed.
+  </li>
+</ul>
+
+<p>After launching the services, navigate to <code>&lt;your_url&gt;:3000/signup</code> to register. The first
+  account created will automatically receive admin permissions, allowing you to later disable further registrations
+  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>
+  <li>Search your content or start a chat conversation for assistance.</li>
+</ul>
+
+<p>Visit the <code>/knowledge</code> page to view your content organized by different sections. This page also
+  provides a visual demonstration of the graph database structure, enhancing your understanding of content
+  relationships.</p>
+
+<p>This streamlined setup ensures intuitive onboarding while offering robust customization options. Whether you are
+  a novice or an advanced user, Minne is designed to deliver a smooth experience and reliable performance.</p>
+{% endblock %}

crates/html-router/templates/documentation/index.html

@@ -0,0 +1,26 @@
+{% extends "documentation/base.html" %}
+{% block article %}
+<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
+  better decision-making and productivity.
+</p>
+<p>
+  This documentation will guide you through the core concepts, tools, and best practices for building and
+  maintaining your own PKM system.
+</p>
+<div class="card bg-base-200 rounded-lg shadow-md">
+  <div class="card-body">
+    <h3 class="card-title not-prose">Getting Started</h3>
+    <p>
+      To begin, explore the sections in the navigation menu. Each section provides detailed insights into
+      different
+      aspects of PKM, from foundational principles to advanced techniques.
+    </p>
+    <div class="card-actions">
+      <a href="/documentation/quick-start" class="btn btn-primary text-primary-content" hx-boost="true">Learn More</a>
+    </div>
+  </div>
+</div>
+{% endblock %}

crates/html-router/templates/documentation/menu.html

@@ -0,0 +1,28 @@
+<ul class="menu bg-base-200 rounded-box w-full ">
+  <li><a hx-boost="true" class="{{'menu-active' if current_path=='/index' }}" href="/documentation">Start</a></li>
+  <li><a hx-boost="true" class="{{'menu-active' if current_path=='/get-started' }}"
+      href="/documentation/get-started">Get Started</a></li>
+  <li><a hx-boost="true" class="{{'menu-active' if current_path=='/mobile-friendly' }}"
+      href="/documentation/mobile-friendly">Mobile friendly</a></li>
+  <li><a hx-boost="true" class="{{'menu-active' if current_path=='/privacy-policy' }}"
+      href="/documentation/privacy-policy">Privacy Policy</a></li>
+  <li>
+    <details open>
+      <summary>Core Concepts</summary>
+      <ul>
+        <li><a hx-boost="true" href="/documentation/submenu1">What is PKM?</a></li>
+        <li><a hx-boost="true" href="/documentation/submenu2">Benefits of PKM</a></li>
+      </ul>
+    </details>
+  </li>
+  <li>
+    <details>
+      <summary>Tools & Techniques</summary>
+      <ul>
+        <li><a hx-boost="true" href="/documentation/tools">Tools for PKM</a></li>
+        <li><a hx-boost="true" href="/documentation/techniques">Effective Techniques</a></li>
+      </ul>
+    </details>
+  </li>
+  <li><a hx-boost="true" href="/documentation/faq">FAQ</a></li>
+</ul>

crates/html-router/templates/documentation/mobile_friendly.html

@@ -0,0 +1,20 @@
+{% extends 'documentation/base.html' %}
+{% block article %}
+<h1>Mobile Friendly Ingression: How to Submit Content from iOS to Minne</h1>
+<p>Minne is built with simplicity in mind. Whether you wish to save a file, capture a thought, or share a page,
+  submitting content is effortless. Our server provides API access that enables users to perform actions using a
+  personalized API key.</p>
+
+<p>An iOS shortcut has been developed to streamline the process of sending content. To begin, navigate to
+  <code>/account</code> and generate an API key. Once created, you will see an option to download the iOS shortcut.
+</p>
+
+<p>After downloading the shortcut, update the "Get response from URL" authentication headers with your API key. If
+  you are self-hosting, ensure the URL is adjusted accordingly.</p>
+
+<p>The shortcut integrates seamlessly with iOS. When you "share with Minne," you will be prompted to provide
+  instructions to the AI and to either choose an existing category or create a new one for your submission.</p>
+
+<p>While an Android solution is in the works, for now you can add the web app to your home screen as a Progressive
+  Web App (PWA) for a similar mobile-friendly experience.</p>
+{% endblock %}

crates/html-router/templates/documentation/privacy.html

@@ -0,0 +1,27 @@
+{% extends 'documentation/base.html' %}
+{% block article %}
+<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>
+
+<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>
+
+<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>
+
+<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>
+
+<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>
+
+<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>
+{% endblock %}