Skip to content

Commit

Permalink
Improvement documentation (#440)
Browse files Browse the repository at this point in the history
* Add image of the first chatbot

* Add to the tutorial how to name your bot from the terminal and change the screen picture with this nwe name

* Add to the tutorial how to name your bot from the terminal and change the screen picture with this new name

* Make same changes but in index.md inside folder code

* Add some changes at readme.md

* Add difference between windows and unix

---------

Co-authored-by: Mauricio_Aguas <[email protected]>
  • Loading branch information
MauricioAguasFonseca and Mauricio_Aguas authored Oct 30, 2024
1 parent ae315f0 commit 42b74cc
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 5 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,11 @@ Notice that `deploy` needs a `HAL9_TOKEN` environment variable with an API token


```bash
HAL9_TOKEN=H9YOURTOKEN hal9 deploy chatbot
HAL9_TOKEN=H9YOURTOKEN hal9 deploy chatbot --name my_first_chatbot
```
As easy as that you have created your first chatbot!

![alt text](image-2.png)

The code inside `/chatbot/app.py` contains a "Hello World" chatbot that reads the user prompt and echos the result back:

Expand Down Expand Up @@ -77,7 +80,19 @@ You can then run your project as follows:
hal9 run chatbot
```

If you customized your template with `--template` make sure to set the correct key, for example `export OPENAI_KEY=YOUR_OPENAI_KEY`.
If you customized your template with `--template` make sure to set the correct key, for example, if you are using the OpenAI template use for Linux or macOS:

```bash
export OPENAI_KEY=YOUR_OPENAI_KEY.
```
For Windows use:

```bash
set OPENAI_KEY=YOUR_OPENAI_KEY.
```

For more information on obtaining and using your OpenAI API key, please refer to the [OpenAI API Key documentation](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key).


You can then run your application locally with:

Expand Down
Binary file added image-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/learn/code/image-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 17 additions & 3 deletions website/learn/code/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,11 @@ Notice that `deploy` needs a `HAL9_TOKEN` environment variable with an API token


```bash
HAL9_TOKEN=H9YOURTOKEN hal9 deploy chatbot
HAL9_TOKEN=H9YOURTOKEN hal9 deploy chatbot --name my_first_chatbot
```
As easy as that you have created your first chatbot!

![alt text](image-2.png)

The code inside `/chatbot/app.py` contains a "Hello World" chatbot that reads the user prompt and echos the result back:

Expand Down Expand Up @@ -77,7 +80,18 @@ You can then run your project as follows:
hal9 run chatbot
```

If you customized your template with `--template` make sure to set the correct key, for example `export OPENAI_KEY=YOUR_OPENAI_KEY`.
If you customized your template with `--template` make sure to set the correct key, for example, if you are using the OpenAI emplate use for Linux or macOS:

```bash
export OPENAI_KEY=YOUR_OPENAI_KEY.
```
For Windows use:

```bash
set OPENAI_KEY=YOUR_OPENAI_KEY.
```
For more information on obtaining and using your OpenAI API key, please refer to the [OpenAI API Key documentation](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key).


You can then run your application locally with:

Expand All @@ -99,4 +113,4 @@ hal9 deploy chatbot --target hal9

Each command is tasked with preparing the deployment of your project folder. For example, `--target docker` should create a `Dockerfile` file that gets this project ready to run in cloud containers.

For personal use, `--target hal9` supports a free tier at `hal9.com`; enterprise support is also available to deploy with `--target hal9 --url hal9.yourcompany.com`
For personal use, `--target hal9` supports a free tier at `hal9.com`; enterprise support is also available to deploy with `--target hal9 --url hal9.yourcompany.com`

0 comments on commit 42b74cc

Please sign in to comment.