docs

gizatechxyz · Feb 26, 2024 · 48ac7cf · 48ac7cf
1 parent 11c4900
commit 48ac7cf
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 7 deletions.
diff --git a/docs/welcome/Installation.md b/docs/welcome/Installation.md
@@ -1,10 +1,5 @@
 # Installation
 
-* [Installation](Installation.md#-installation)
-  * [Recommended installation with pipx](Installation.md#recommended-installation-with-pipx)
-  * [Install from PyPi](Installation.md#install-from-pypi)
-  * [Installing from source](Installation.md#installing-from-source)
-
 ## Handling Python versions with Pyenv
 
 As we are using Python 3.11, it's recommended to use [Pyenv](https://github.com/pyenv/pyenv) to manage your Python versions. Here are the steps to install Pyenv and set Python 3.11 as your local version:

diff --git a/docs/welcome/authentication.md b/docs/welcome/authentication.md
@@ -4,14 +4,16 @@ Authentication is a critical aspect of our platform, ensuring secure access to r
 
 ## What are JWT and API keys?
 
-* _JWT (JSON Web Token)_: A JWT is a compact, URL-safe means of representing claims between two parties. In the context of our platform, it serves as a secure authentication token obtained through the giza users login command. This token is then used to establish and maintain a secure communication channel with the platform.
-* _API Key_: An API key is a unique alphanumeric code generated by the platform that provides a secure way for applications or users to authenticate themselves. Once created, an API key serves as a credential to communicate with the platform, eliminating the need for repeated login procedures.
+* *JWT (JSON Web Token)*: A JWT is a compact, URL-safe means of representing claims between two parties. In the context of our platform, it serves as a secure authentication token obtained through the giza users login command. This token is then used to establish and maintain a secure communication channel with the platform.
+
+* *API Key*: An API key is a unique alphanumeric code generated by the platform that provides a secure way for applications or users to authenticate themselves. Once created, an API key serves as a credential to communicate with the platform, eliminating the need for repeated login procedures.
 
 ## Key Differences
 
 The primary distinction between JWT and API keys lies in their nature and usage:
 
 * JWT is a token-based authentication mechanism that is time-sensitive and typically used for short-lived authentication sessions.
+
 * API keys, on the other hand, are static credentials that persist and provide a more long-term solution for authentication without the need for frequent renewals.
 
 ## How to authenticate