rename docs for better publication in docusaurus

README.md

@@ -16,7 +16,6 @@ You can login with your Nuclia user [How to sign-up](https://nuclia.cloud/user/s
 nuclia auth login
 ```
 
-
 ### Nuclia Knowledgebox
 
 You can login to a specific knowledgebox if you have a Service Token (How to get a Service Token) or your NucliaDB is [deployed on-premise](https://docs.nuclia.dev/docs/nucliadb/deploy)
@@ -27,7 +26,6 @@ nuclia auth kb --url KB_URL --token SERVICE_TOKEN
 
 KB_URL its the url of the Knowledge Box. On the cloud service you can retrieve it on the dashboard. On the on-premise/community deployment its the url mapped to it.
 
-
 ### Nuclia Understanding API
 
 You can login with a Nuclia Understanding API key to process files, predict and train using our system
@@ -38,4 +36,4 @@ nuclia auth nua --key ZZZZ
 
 ## Documentation
 
-You can find the documentation [here](https://github.com/nuclia/nuclia.py/tree/main/docs)
+You can find the documentation [here](https://github.com/nuclia/nuclia.py/tree/main/docs/01-README.md)

docs/01-README.md

@@ -0,0 +1,33 @@
+# Nuclia CLI/SDK
+
+This SDK/CLI is designed to facilitate use of the Nuclia API.
+
+There are two developer experiences:
+
+- CLI: by using the cli `nuclia` you can interact with Nuclia via command line
+- SDK: Using python you can replicate each command using the same structure
+
+It requires Python (≥3.8) and can be installed with:
+
+```sh
+pip install nuclia
+```
+
+## Getting started
+
+First steps should be:
+
+- [Authentication](02-auth.md)
+- [Setting KnowledgeBox or NUA key](03-default.md).
+
+## Use Cases
+
+- [Upload files](04-upload.md)
+- [Upload url](04-upload.md)
+- [Upload text](04-upload.md)
+- [Upload conversation](07-conversation.md)
+- [Search](06-search.md)
+- [Extract information from a file](05-extract.md)
+- Detect Entities
+- [Get embedding from text](05-extract.md)
+- Get answer from a context

docs/UPLOAD.md → docs/04-upload.md

@@ -1,6 +1,6 @@
 # Upload use case
 
-All examples assume you [authenticated](AUTH.md) and defined a [default](DEFAULT.md) knowledgebox. In case you want to overwrite or define a one time knowledgebox you should add on any command/function the `url` and `api_key` parameter.
+All examples assume you [authenticated](02-auth.md) and defined a [default](03-default.md) knowledgebox. In case you want to overwrite or define a one time knowledgebox you should add on any command/function the `url` and `api_key` parameter.
 
 ## Upload a file in a KnowledgeBox
 
@@ -82,7 +82,6 @@ Pass `origin` or `extra` metadata:
 nuclia kb upload text --path=FILE_PATH --origin='{"url":"https://somwhere.com"}' --extra='{"metadata":{"whatever":42}}'
 ```
 
-
 ## Upload an URL in a KnowledgeBox
 
 Push a text to a knowledgebox:

docs/EXTRACT.md → docs/05-extract.md

@@ -1,6 +1,6 @@
 # Extract data from a resource
 
-Once you have [uploaded](UPLOAD.md) a resource you can extract data from it.
+Once you have [uploaded](04-upload.md) a resource you can extract data from it.
 
 ```bash
 nuclia kb resource get --rid=RESOURCE_ID --show=extracted --json
@@ -38,4 +38,4 @@ nuclia kb resource get --rid=RESOURCE_ID --show=extracted --extracted=vectors --
 from nuclia import sdk
 resource = sdk.NucliaResource()
 resource.get(rid=RESOURCE_ID, show='extracted', extracted='vectors')
-```
+```

docs/CONVERSATION.md → docs/07-conversation.md

@@ -1,6 +1,6 @@
 # Conversational use case
 
-All examples has assumed you [authenticated](AUTH.md) and defined a [default](DEFAULT.md) knowledgebox. In case you want to overwrite or define a one time knowledgebox you should add on any command/function the `url` and `api_key` parameter.
+All examples has assumed you [authenticated](02-auth.md) and defined a [default](03-default.md) knowledgebox. In case you want to overwrite or define a one time knowledgebox you should add on any command/function the `url` and `api_key` parameter.
 
 ## Upload messages
 
@@ -35,8 +35,8 @@ nuclia kb upload conversation --path=FILE
 
 ## Upload files
 
-[Upload documentation](UPLOAD.md)
+[Upload documentation](04-upload.md)
 
 ## Search on it
 
-[Search documentation](SEARCH.md)
+[Search documentation](06-search.md)