From dfdce388a455d09f0ac0f01a98b7bc4b9b27ed44 Mon Sep 17 00:00:00 2001
From: Laurin Weger <Laurin-W@users.noreply.github.com>
Date: Thu, 27 Jun 2024 17:06:25 +0200
Subject: [PATCH] component descriptions

---
 ng-app/src/lib/Install.svelte         | 6 +++++-
 ng-app/src/lib/NoWallet.svelte        | 5 +++++
 ng-app/src/routes/Home.svelte         | 7 +++++--
 ng-app/src/routes/User.svelte         | 6 ++++++
 ng-app/src/routes/WalletCreate.svelte | 7 +++++++
 ng-app/src/routes/WalletLogin.svelte  | 6 ++++++
 6 files changed, 34 insertions(+), 3 deletions(-)

diff --git a/ng-app/src/lib/Install.svelte b/ng-app/src/lib/Install.svelte
index 1b1af5a..14ef5bd 100644
--- a/ng-app/src/lib/Install.svelte
+++ b/ng-app/src/lib/Install.svelte
@@ -9,8 +9,12 @@
 // according to those terms.
 -->
 
+<!--
+  Info Component about the NextGraph app and download links.
+-->
+
 <script lang="ts">
-  import { Button, Alert } from "flowbite-svelte";
+  import { Alert } from "flowbite-svelte";
   import { link } from "svelte-spa-router";
 
   // @ts-ignore
diff --git a/ng-app/src/lib/NoWallet.svelte b/ng-app/src/lib/NoWallet.svelte
index 12aa7a1..51a5518 100644
--- a/ng-app/src/lib/NoWallet.svelte
+++ b/ng-app/src/lib/NoWallet.svelte
@@ -9,6 +9,11 @@
 // according to those terms.
 -->
 
+<!--
+  Component to inform the user, that no wallet is registered on this device.
+  Offers login or create wallet buttons.
+-->
+
 <script>
   // @ts-ignore
   import Logo from "../assets/nextgraph.svg?component";
diff --git a/ng-app/src/routes/Home.svelte b/ng-app/src/routes/Home.svelte
index 8cd1425..5873e7d 100644
--- a/ng-app/src/routes/Home.svelte
+++ b/ng-app/src/routes/Home.svelte
@@ -9,9 +9,12 @@
 // according to those terms.
 -->
 
+<!--
+  Home page to display for logged in users.
+  Redirects to no-wallet or login page, if not logged in.
+-->
+
 <script>
-  import { Button } from "flowbite-svelte";
-  import { link } from "svelte-spa-router";
   import Home from "../lib/Home.svelte";
   import NoWallet from "../lib/NoWallet.svelte";
   import { push } from "svelte-spa-router";
diff --git a/ng-app/src/routes/User.svelte b/ng-app/src/routes/User.svelte
index 753fb83..7e3bb87 100644
--- a/ng-app/src/routes/User.svelte
+++ b/ng-app/src/routes/User.svelte
@@ -8,6 +8,12 @@
 // notice may not be copied, modified, or distributed except
 // according to those terms.
 -->
+
+<!--
+  "User Panel" page.
+  Provides wallet download, logout, offline/online switch, and other user actions.
+-->
+
 <script>
   // @ts-nocheck
 
diff --git a/ng-app/src/routes/WalletCreate.svelte b/ng-app/src/routes/WalletCreate.svelte
index 0e0dfa1..34619fb 100644
--- a/ng-app/src/routes/WalletCreate.svelte
+++ b/ng-app/src/routes/WalletCreate.svelte
@@ -9,6 +9,13 @@
 // according to those terms.
 -->
 
+<!--
+  Wallet creation page.
+  This component manages the whole UX flow, gives infos about wallets,
+   offers available brokers, handles wallet creation,
+   and shows the wallet pazzle and pin.
+-->
+
 <script lang="ts">
   import { Button, Alert, Dropzone, Toggle } from "flowbite-svelte";
   import { link, querystring } from "svelte-spa-router";
diff --git a/ng-app/src/routes/WalletLogin.svelte b/ng-app/src/routes/WalletLogin.svelte
index fe54473..eb0bf5b 100644
--- a/ng-app/src/routes/WalletLogin.svelte
+++ b/ng-app/src/routes/WalletLogin.svelte
@@ -9,6 +9,12 @@
 // according to those terms.
 -->
 
+<!--
+  "Select a wallet to login with" page.
+  This page is usually the first page the user sees when they visit the app.
+  It allows the user to select a wallet to login with, create, or import a wallet.
+-->
+
 <script lang="ts">
   import { onMount, onDestroy, tick } from "svelte";
   import { link, push } from "svelte-spa-router";