docs: split it in setup (README) and API usage parts

The API usage part will show up in the main KernelCI docs.

Signed-off-by: Gustavo Padovan <gustavo.padovan@collabora.com>

Author: padovan

README.md

@@ -18,24 +18,7 @@ container=""
 sastoken=""
 ```
 
-## API
-
-### Upload
-
-`POST /upload`
-
-Upload a file to the server.
-
-field path: the path to store the file in the server.
-field file0: the file to upload.
-
-### Download
-
-`GET /path/to/file`
-
-Download a file from the server.
-
-### Authentication
+## Creating user tokens
 
 The server uses JWT token based authentication. The token is passed in the `Authorization` header as a Bearer token.
 JWT secret is configured in the `config.toml` file.
@@ -45,7 +28,7 @@ JWT secret is configured in the `config.toml` file.
 ```
 This will generate a JWT token for the user.
 
-#### Testing Token Validity
+### Testing Token Validity
 
 You can verify if a token is valid using the `/v1/checkauth` endpoint:
 
@@ -58,46 +41,6 @@ curl -X GET http://localhost:3000/v1/checkauth \
 - `200 OK` with body `Authorized: user@email.com` - Token is valid
 - `401 Unauthorized` with body `Unauthorized` - Token is invalid or missing
 
-### Testing upload and download using curl
-
-```bash
-# Upload
-curl -X POST http://files.kernelci.org/upload \
-    -H "Authorization: Bearer <JWT_TOKEN>" \
-    -F "path=testfolder" \
-    -F "file0=@local_folder/local_file"
-
-# File will be uploaded to Azure Blob Storage as testfolder/local_folder/local_file
-
-# Download
-curl http://files.kernelci.org/testfolder/local_folder/local_file
-```
-
-## Principle of operation
-
-```mermaid
-sequenceDiagram
-    participant User
-    participant Proxy Server
-    participant Local Cache
-    participant Azure Blob Storage
-
-    %% Upload Flow
-    User->>Proxy Server: Upload File (POST Request)
-    Proxy Server->>Azure Blob Storage: Store File in Cloud
-    Azure Blob Storage-->>Proxy Server: Confirmation
-    Proxy Server-->>User: Upload Successful
+## API
 
-    %% Download Flow
-    User->>Proxy Server: Request File (GET Request)
-    Proxy Server->>Local Cache: Check if File Exists
-    alt File Found in Cache
-        Local Cache-->>Proxy Server: Return Cached File
-        Proxy Server-->>User: Send File
-    else File Not in Cache
-        Proxy Server->>Azure Blob Storage: Fetch File from Cloud
-        Azure Blob Storage-->>Proxy Server: Send File Data
-        Proxy Server->>Local Cache: Save File Locally
-        Proxy Server-->>User: Send File
-    end
-```
+See [docs](docs/) for the API documentation.

docs/_index.md

@@ -0,0 +1,74 @@
+---
+title: "kernelci-storage"
+date: 2025-08-06
+description: KernelCI's Storage API documentation
+---
+
+We have simple storage server that supports file upload and download, with JWT token based authentication.
+
+## API Endpoints
+
+The API is quite simple with upload through a `/upload` endpoint and download through a GET to the file url.
+
+### Upload
+
+`POST /upload`
+
+Upload a file to the server.
+
+field path: the path to store the file in the server.
+field file0: the file to upload.
+
+### Download
+
+`GET /path/to/file`
+
+Download a file from the server.
+
+### Request a token
+
+Ask the kernelci-sysadmin team for a token.
+
+### Testing upload and download using curl
+
+```bash
+# Upload
+curl -X POST http://files.kernelci.org/upload \
+    -H "Authorization: Bearer <JWT_TOKEN>" \
+    -F "path=testfolder" \
+    -F "file0=@local_folder/local_file"
+
+# File will be uploaded to Azure Blob Storage as testfolder/local_folder/local_file
+
+# Download
+curl http://files.kernelci.org/testfolder/local_folder/local_file
+```
+
+## Principle of operation
+
+```mermaid
+sequenceDiagram
+    participant User
+    participant Proxy Server
+    participant Local Cache
+    participant Azure Blob Storage
+
+    %% Upload Flow
+    User->>Proxy Server: Upload File (POST Request)
+    Proxy Server->>Azure Blob Storage: Store File in Cloud
+    Azure Blob Storage-->>Proxy Server: Confirmation
+    Proxy Server-->>User: Upload Successful
+
+    %% Download Flow
+    User->>Proxy Server: Request File (GET Request)
+    Proxy Server->>Local Cache: Check if File Exists
+    alt File Found in Cache
+        Local Cache-->>Proxy Server: Return Cached File
+        Proxy Server-->>User: Send File
+    else File Not in Cache
+        Proxy Server->>Azure Blob Storage: Fetch File from Cloud
+        Azure Blob Storage-->>Proxy Server: Send File Data
+        Proxy Server->>Local Cache: Save File Locally
+        Proxy Server-->>User: Send File
+    end
+```