Updates to documentation

Author: vascosousamindera

docs/global-artifacts/01.requirements-engineering/puml/use-case-diagram.puml

@@ -1,7 +1,7 @@
 @startuml use-case-diagram
 left to right direction
 
-actor "Developer or CI/CD Pipeline" as Dev
+actor "Developer" as Dev
 
 rectangle "Melmac Performance Testing Framework" {
     usecase "UC1: As a Developer, I want to create a Test Suite" as UC1

docs/global-artifacts/01.requirements-engineering/use-cases.md

@@ -4,17 +4,17 @@
 
 The use case diagram provides a high-level overview of the system's functionality by illustrating the interactions between users (actors) and the system's use cases. It helps identify the main actors and their goals when using the system.
 
-![Use Case Diagram](./USE-CASE-DIAGRAM.svg)
+![Use Case Diagram](./svg/use-case-diagram.svg)
 
 ## Use Cases
 
 This section outlines the specific use cases for the system, detailing the interactions between actors and the system. Each use case includes a description, preconditions, and postconditions to clarify the expected behavior of the system.
 
 | Use Case                   | Description                                                                  |
 | -------------------------- | ---------------------------------------------------------------------------- |
-| **UC1: Create Test Suite** | The user creates a new test suite to organize related test scripts.          |
-| **UC2: Create Test Plan**  | The user defines a test script, specifying objectives, scope, and resources. |
-| **UC3: Run Test Suite**    | The user executes all test scripts within a selected test suite.             |
-| **UC4: Run Test Plan**     | The user initiates the execution of a specific test script.                  |
+| **UC1: As a Developer, I want to create a Test Suite** | The user creates a new test suite to organize related test scripts.          |
+| **UC2: As a Developer, I want to create a Test Plan**  | The user defines a test script, specifying objectives, scope, and resources. |
+| **UC3: As a Developer, I want to run a Test Suite**    | The user executes all test scripts within a selected test suite.             |
+| **UC4: As a Developer, I want to run a Test Plan**     | The user initiates the execution of a specific test script.                  |
 
 ---

script.txt docs/global-artifacts/script.mdscript.txt renamed to docs/global-artifacts/script.md

@@ -1,12 +1,19 @@
-# 1. Create Test Suite
+# Alfie Melmac Performance Testing - API Usage
+
+## 1. Create Test Suite
+
+```bash
 curl -X POST http://localhost:8080/test-suites \
   -H "Content-Type: application/json" \
   -d '{
     "testSuiteName": "My Test Suite",
     "testSuiteDescription": "Description of my test suite"
   }'
+```
+
+## 2. Create Android Test Plan
 
-# 2. Create Android Test Plan
+```bash
 curl -X POST http://localhost:8080/test-plans \
   -H "Content-Type: application/json" \
   -d '{
@@ -39,8 +46,11 @@ curl -X POST http://localhost:8080/test-plans \
     "executionTypeParameters": [],
     "testSuiteVersionId": 1
   }'
+```
 
-# 3. Create iOS Test Plan
+## 3. Create iOS Test Plan
+
+```bash
 curl -X POST http://localhost:8080/test-plans \
   -H "Content-Type: application/json" \
   -d '{
@@ -72,9 +82,16 @@ curl -X POST http://localhost:8080/test-plans \
     "executionTypeParameters": [],
     "testSuiteVersionId": 1
   }'
+```
+
+## 4. Execute Test Suite
 
-# 4. Execute Test Suite
+```bash
 curl -X POST http://localhost:8080/test-suites/1/run
+```
+
+## 5. Execute Single Test Plan
 
-# 5. Execute Single Test Plan
+```bash
 curl -X POST "http://localhost:8080/test-executions/run?testPlanVersionId=2"
+```

readme.md

@@ -104,4 +104,14 @@ curl -X GET http://localhost:8080/api/endpoint
 
 Replace `GET` with the desired HTTP method and update the URL to match your application's endpoint.
 
+You can find API usage examples at [`docs/global-artifacts/script.md`](docs/global-artifacts/script.md). This document provides detailed, step-by-step instructions on how to create test plans and execute them using the API.
+
+## 8. How to Configure CI/CD workflows
+
+To configure CI/CD workflows, you can use tools like [GitHub Actions](https://docs.github.com/en/actions), [GitLab CI](https://docs.gitlab.com/ee/ci/), or [Jenkins](https://www.jenkins.io/doc/).  
+You can find example workflow files in the [`.github/workflows`](.github/workflows) directory. These files are clickable and define how your project is built, tested, and deployed.  
+Click on a workflow file to view or edit its configuration directly in your repository.
+
+**Note:** The workflow templates provided are static. If you need to change any parameters (such as environment variables, build steps, or triggers), you must edit the workflow YAML files and commit the changes to your repository for them to take effect.
+
 <img width=100% src="https://capsule-render.vercel.app/api?type=waving&height=120&color=3A4A51&reversal=true&textBg=false&section=footer"/>