📝 Update documentation for installation and command usage (#718)

* ♻️ Update documentation for installation and command usage * ♻️ Remove redundant closing div tag in documentation
yezz123 · Dec 22, 2024 · cba8572 · cba8572
1 parent b634d0b
commit cba8572
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 7 deletions.
diff --git a/docs/development/contributing.md b/docs/development/contributing.md
@@ -159,7 +159,7 @@ All the documentation is in Markdown format in the directory `./docs`.
 <div class="termy">
 
 ```console
-uv pip install requirements-docs.txt
+uv sync --group docs --all-extras
 
 bash scripts/docs_build.sh
 ```
@@ -245,6 +245,8 @@ If you want to generate the test report:
 <div class="termy">
 
 ```console
+$ uv sync --group test --all-extras
+
 $ bash scripts/test.sh
 ```
 

diff --git a/docs/index.md b/docs/index.md
@@ -29,15 +29,25 @@ customizable and adaptable as possible.
 
 ## Installation
 
-<div class="termy">
+=== "pip"
 
-```console
-$ pip install authx
+    <div class="termy">
 
----> 100%
-```
+    ```console
+    $ pip install authx
+    ```
+
+    </div>
+
+=== "uv"
+
+    <div class="termy">
+
+    ```console
+    $ uv add authx
+    ```
 
-</div>
+    </div>
 
 ## Features