add index page for docs

README.md

@@ -6,7 +6,9 @@ Documentation, contribution rules, process and the code itself (this includes th
 
 ## Installation
 
-Install [Hatch](https://hatch.pypa.io/latest/install/#pipx).
+```
+pip install saleor-sdk-python
+```
 
 ## Tooling
 
@@ -26,30 +28,45 @@ saleor-sdk tools decode-id VXNlcjoyMg==
 saleor-sdk tools encode-id User 22
 ```
 
-## Documentation
+## Development
+
+To contribute to this repository you will need Hatch to setup a local development environment. 
+
+Install [Hatch](https://hatch.pypa.io/latest/install/#pipx).
+
+### Documentation
+
+You can deploy a local documentation service, it reloads changes and allow for a live preview of how the documentation will look like after publication:
 
 ```
 hatch run docs:serve
 ```
 
 and navigate to http://127.0.0.1:8000
 
-## Tests
+### Tests
+
+With the following command you can run tests: 
 
 ```
 hatch run test 
 ```
 
-## Build and deploy
+### Code style
+
+This library follows a specific style guide, to achieve the proper format and lint the code the following commands should be used:
 
 ```
-hatch build -c
-hatch publish
+hatch run lint:fmt
+hatch run lint:all
 ```
 
-## Code style
+
+### Build and deploy
+
+This is done by a CI/CD workflow upon the creation of a release but in case of the need for a manual publication of the packager to PyPI you need to build the package archive and publish it. 
 
 ```
-hatch run lint:fmt
-hatch run lint:all
+hatch build -c
+hatch publish
 ```

docs/css/extra.css

@@ -1,3 +1,24 @@
 header {
     border-bottom: 4px solid var(--md-accent-fg-color);
 }
+
+.md-copyright {
+    width: 100%;
+}
+
+
+.md-copyright .made-with-love{
+    float: right;
+    line-height: 24px;
+}
+
+.md-copyright .made-with-love .footer_mirumee_logo{
+    height: 24px;
+    vertical-align: top;
+    opacity: 0.7;
+}
+
+
+.md-copyright .made-with-love:hover .footer_mirumee_logo{
+    opacity: 1;
+}

docs/index.md

@@ -1,3 +1,28 @@
 # Introduction
 
-TDB...
+Saleor SDK Python is a Python library which purpose is to contain code that is repeated in different Saleor applications.
+
+You should read [Saleor's Documentation](https://docs.saleor.io/docs/3.x/developer/extending/overview) on the topic to get a grasp on the concepts of the "app framework" Saleor comes with.
+
+This SDK is agnostic of any framework, which makes it possible to use in all sorts of web (or otherwise) frameworks and even scripts.
+
+## What about Python App Framework?
+
+The old [saleor-app-framework-python](https://github.com/mirumee/saleor-app-framework-python) was very opinionated on how an application should be crated. It required FastAPI and in a specific version of it.  
+
+## Installation
+
+```
+pip install saleor-sdk-python
+```
+
+## Key features
+
+- CLI with tooling that helps to decode and encode Saleor IDs - this is useful when a entity type or ID needs to be recognized from a GraphQL ID
+- Crypto module helping with Saleor authentication, both JWT verification and webhook signature verification - provides a way to manage Saleor issued signatures
+- Marina module - more on that in a later time...
+
+## Best served with
+
+- https://ariadnegraphql.org/
+- https://github.com/mirumee/ariadne-codegen

docs/overrides/partials/copyright.html

@@ -0,0 +1,19 @@
+{#-
+  This file was automatically generated - do not edit
+-#}
+<div class="md-copyright">
+  {% if config.copyright %}
+    <div class="md-copyright__highlight">
+      {{ config.copyright }}
+    </div>
+  {% endif %}
+  {% if not config.extra.generator == false %}
+    Made with
+    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+      Material for MkDocs
+    </a>
+  {% endif %}
+  <div class="md-copyright__highlight made-with-love">
+    <a href="https://mirumee.com">Saleor SDK Python is crafted with love by <img class="footer_mirumee_logo" src="/assets/mirumee.png" alt="Mirumee"></a>
+  </div>
+</div>

mkdocs.yml

@@ -1,9 +1,13 @@
 site_name: Saleor SDK Python
 repo_url: https://github.com/mirumee/saleor-sdk-python
 edit_uri: edit/main/docs/
+copyright: Copyright © 2024 - Mirumee Software
 
 theme:
+  logo: /assets/marina_logo_white.svg
+  favicon: /assets/marina_logo.svg
   name: material
+  custom_dir: docs/overrides
   palette:
     # Palette toggle for light mode
     - media: "(prefers-color-scheme: light)"