From 8976c0e89a5389b7f45f900727b6dbaca2bee824 Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Tue, 20 Aug 2024 23:34:10 +0530 Subject: [PATCH] Fix example directory names --- README.md | 2 +- ballerina/Module.md | 2 +- ballerina/Package.md | 2 +- examples/README.md | 2 +- examples/{CLI-assistant => cli-assistant}/.github/README.md | 0 examples/{CLI-assistant => cli-assistant}/Ballerina.toml | 0 examples/{CLI-assistant => cli-assistant}/cli assistant.md | 0 examples/{CLI-assistant => cli-assistant}/main.bal | 0 8 files changed, 4 insertions(+), 4 deletions(-) rename examples/{CLI-assistant => cli-assistant}/.github/README.md (100%) rename examples/{CLI-assistant => cli-assistant}/Ballerina.toml (100%) rename examples/{CLI-assistant => cli-assistant}/cli assistant.md (100%) rename examples/{CLI-assistant => cli-assistant}/main.bal (100%) diff --git a/README.md b/README.md index bfee055..5cf8d8b 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ bal run The `OpenAI Chat` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/module-ballerinax-openai.chat/tree/main/examples/), covering the following use cases: -1. [CLI assistant](https://github.com/ballerina-platform/module-ballerinax-openai.chat/tree/main/examples/CLI-assistant) - Execute the user's task description by generating and running the appropriate command in the command line interface of their selected operating system. +1. [CLI assistant](https://github.com/ballerina-platform/module-ballerinax-openai.chat/tree/main/examples/cli-assistant) - Execute the user's task description by generating and running the appropriate command in the command line interface of their selected operating system. 2. [Image to markdown document converter](https://github.com/ballerina-platform/module-ballerinax-openai.chat/tree/main/examples/image-to-markdown-converter) - Generate detailed markdown documentation based on the image content. ## Build from the source diff --git a/ballerina/Module.md b/ballerina/Module.md index 5a5504d..d542321 100644 --- a/ballerina/Module.md +++ b/ballerina/Module.md @@ -82,5 +82,5 @@ bal run The `OpenAI Chat` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/module-ballerinax-openai.chat/tree/main/examples/), covering the following use cases: -1. [CLI assistant](https://github.com/ballerina-platform/module-ballerinax-openai.chat/tree/main/examples/CLI-assistant) - Execute the user's task description by generating and running the appropriate command in the command line interface of their selected operating system. +1. [CLI assistant](https://github.com/ballerina-platform/module-ballerinax-openai.chat/tree/main/examples/cli-assistant) - Execute the user's task description by generating and running the appropriate command in the command line interface of their selected operating system. 2. [Image to markdown document converter](https://github.com/ballerina-platform/module-ballerinax-openai.chat/tree/main/examples/image-to-markdown-converter) - Generate detailed markdown documentation based on the image content. \ No newline at end of file diff --git a/ballerina/Package.md b/ballerina/Package.md index 5a5504d..d542321 100644 --- a/ballerina/Package.md +++ b/ballerina/Package.md @@ -82,5 +82,5 @@ bal run The `OpenAI Chat` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/module-ballerinax-openai.chat/tree/main/examples/), covering the following use cases: -1. [CLI assistant](https://github.com/ballerina-platform/module-ballerinax-openai.chat/tree/main/examples/CLI-assistant) - Execute the user's task description by generating and running the appropriate command in the command line interface of their selected operating system. +1. [CLI assistant](https://github.com/ballerina-platform/module-ballerinax-openai.chat/tree/main/examples/cli-assistant) - Execute the user's task description by generating and running the appropriate command in the command line interface of their selected operating system. 2. [Image to markdown document converter](https://github.com/ballerina-platform/module-ballerinax-openai.chat/tree/main/examples/image-to-markdown-converter) - Generate detailed markdown documentation based on the image content. \ No newline at end of file diff --git a/examples/README.md b/examples/README.md index 89964ac..5d05df9 100644 --- a/examples/README.md +++ b/examples/README.md @@ -2,7 +2,7 @@ The `ballerinax/openai.chat` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-openai.chat/tree/main/examples), covering use cases like cache management, session management, and rate limiting. -1. [CLI assistant](https://github.com/ballerina-platform/module-ballerinax-openai.chat/tree/main/examples/CLI-assistant) - Execute the user's task description by generating and running the appropriate command in the command line interface of their selected operating system. +1. [CLI assistant](https://github.com/ballerina-platform/module-ballerinax-openai.chat/tree/main/examples/cli-assistant) - Execute the user's task description by generating and running the appropriate command in the command line interface of their selected operating system. 2. [Image to markdown document converter](https://github.com/ballerina-platform/module-ballerinax-openai.chat/tree/main/examples/image-to-markdown-converter) - Generate detailed markdown documentation based on the image content. ## Prerequisites diff --git a/examples/CLI-assistant/.github/README.md b/examples/cli-assistant/.github/README.md similarity index 100% rename from examples/CLI-assistant/.github/README.md rename to examples/cli-assistant/.github/README.md diff --git a/examples/CLI-assistant/Ballerina.toml b/examples/cli-assistant/Ballerina.toml similarity index 100% rename from examples/CLI-assistant/Ballerina.toml rename to examples/cli-assistant/Ballerina.toml diff --git a/examples/CLI-assistant/cli assistant.md b/examples/cli-assistant/cli assistant.md similarity index 100% rename from examples/CLI-assistant/cli assistant.md rename to examples/cli-assistant/cli assistant.md diff --git a/examples/CLI-assistant/main.bal b/examples/cli-assistant/main.bal similarity index 100% rename from examples/CLI-assistant/main.bal rename to examples/cli-assistant/main.bal