feat(docs): Clarified docs and added logo (#11)

* Added docs structure

* Expanded READMEs

* Updated code reference and started home

* Added readthedocs config

* Expanded docs

* Got started on getting started

* Added emoji support in docs

* Finished first part of getting started

* README fix

* Finished documenting integration step

* Finished prep database

* Finished main getting-started

* Adding future doc pages

* Added demonstration

Solving issue Add demonstration to documentation #6

* Clarifying demonstration

* Clearing up Home

* Adding an icon

* Fixing README logo

README.md

@@ -1,5 +1,7 @@
 # Notion Recurring Tasks
 
+<img alt="Logo" src="docs/assets/icon/white.png" align="right" width="128px"/>
+
 ![Pytest Status](https://github.com/Theeoi/notion-recurring-tasks/actions/workflows/test.yml/badge.svg?label=Tests)
 ![Coverage Status](https://coveralls.io/repos/github/Theeoi/notion-recurring-tasks/badge.svg?branch=main)
 ![Documentation Status](https://readthedocs.org/projects/notion-recurring-tasks/badge/?version=latest)

docs/demonstration.md

@@ -4,7 +4,7 @@ The purpose of the Notion Recurring Tasks software is to detect tasks in your No
 
 ![Recurring Task](assets/img/demonstration-1.PNG)
 
-The above task is done and marked to recur with all properties set. The Status is reset to 'Not started' and the Due Date is set to the new date accoring to the recur properties.
+The above task is done and marked to recur with all properties set. The Status is reset to 'Not started' and the Due Date is set to the new date accoring to the recur properties. The available units are: Days, Weeks, Months and Years.
 
 ![Recurring Task Without Due Date](assets/img/demonstration-2.PNG)
 

docs/index.md

@@ -10,14 +10,18 @@ If you are getting started with the software for the first time is it recommende
 
 1. Download a [release of the program](https://github.com/Theeoi/notion-recurring-tasks/releases)
     - Executable or Source code (Executable recommended for most users)
-2. Set up a [Notion Integration](https://www.notion.so/my-integrations) and get a Notion API key.
+2. Set up a [Notion Integration](https://www.notion.so/my-integrations) and get a Notion API key
 3. Set up your Notion database with the required properties and integration
-4. Install and run the program
+4. Install and run the software
     - The software will prompt you for the key from step 2
-5. [Optional] Automate the execution of the program
+5. [Optional] Automate the execution of the software
 
 ## Documentation Overview
 
+- [Demonstration](demonstration.md)
+
+See how the software updates Notion tasks marked for recurrance.
+
 - [Tutorials](tutorial/index.md)
 
 Learn how to set up and use the Notion Recurring Tasks software in bite-sized chunks.
@@ -40,8 +44,9 @@ If you have an issue or question regarding this software I highly appreciate it
 
 When submitting a new issue it is important to leave as much information as possible. More detailed issues have a higher chance of getting a quick response. Important details to include are:
 
+- What are you trying to do?
+- What do you expect would happen?
+- What is really happening?
+  - What error message are you seeing, if any?
 - What operating system are you using?
-- Is the issue related to the executable or the source code?
-- What error messages are you seeing, if any?
-- A thurough description of your issue
-- If applicable, how to reproduce your issue
+- How would one reproduce your issue?

mkdocs.yml

@@ -7,6 +7,8 @@ validation:
 
 theme:
   name: "material"
+  logo: assets/icon/white.png
+  favicon: assets/icon/black.png
   palette:
     scheme: slate
     primary: black

scripts/build_executable.py

@@ -41,6 +41,7 @@ def build_executable(name: str, path: str) -> None:
         [
             "--clean",
             "--noconfirm",
+            "--icon=docs/assets/icon/black.ico",
             "--add-data=README.md:.",
             f"--name={name}",
             f"src/{path}",