Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

Commit 34a5176

Browse files
committed
update docs
1 parent d4e699d commit 34a5176

File tree

5 files changed

+18
-11
lines changed

5 files changed

+18
-11
lines changed

docs/docs/demos/chatbox-vid.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/docs/demos/chatbox-vid.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Run local chatbox under 1 minute on MacOS with Nitro
3+
---
4+
5+
<iframe width="675" height="380" src="https://www.youtube.com/embed/_AQXQDjw7Y8" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

docs/docs/examples/chatbox.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ To download and install Chatbox, follow the instructions available at this [link
1616

1717
## Using Nitro as a Backend
1818

19-
1. Start Nitro server
19+
**1. Start Nitro server**
2020

2121
Open your command line tool and enter:
2222
```
2323
nitro
2424
```
2525

26-
2. Download Model
26+
**2. Download Model**
2727

2828
Use these commands to download and save the [Llama2 7B chat model](https://huggingface.co/TheBloke/Llama-2-7B-Chat-GGUF/tree/main):
2929

@@ -34,7 +34,7 @@ wget -O llama-2-7b-model.gguf https://huggingface.co/TheBloke/Llama-2-7B-Chat-GG
3434

3535
> For more GGUF model, please look at [The Bloke](https://huggingface.co/TheBloke).
3636
37-
3. Run the Model
37+
**3. Run the Model**
3838

3939
To load the model, use the following command:
4040

@@ -48,11 +48,16 @@ curl http://localhost:3928/inferences/llamacpp/loadmodel \
4848
}'
4949
```
5050

51-
4. Config chatbox
51+
**4. Config chatbox**
52+
5253
Adjust the `settings` in Chatbox to connect with Nitro. Change your settings to match the configuration shown in the image below:
5354

5455
![Settings](img/chatbox.PNG)
5556

56-
5. Chat with the Model
57+
**5. Chat with the Model**
58+
59+
Once the setup is complete, you can start chatting with the model using Chatbox. All functions of Chatbox are now enabled with Nitro as the backend.
60+
61+
## Futher Usage
5762

58-
Once the setup is complete, you can start chatting with the model using Chatbox. All functions of Chatbox are now enabled with Nitro as the backend.
63+
For convenient usage, you can utilize [Jan](https://jan.ai/), as it is integrated with Nitro.

docs/docs/new/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: About Nitro
3-
slug: /about
3+
slug: /docs
44
---
55

66
Nitro is a high-efficiency C++ inference engine for edge computing, powering [Jan](https://jan.ai/). It is lightweight and embeddable, ideal for product integration.

docs/sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ const sidebars = {
7171
// collapsed: false,
7272
// items: [{ type: "doc", id: "new/architecture", label: "Architecture" }],
7373
// },
74-
"new/faq",
7574
{
7675
type: "category",
7776
label: "Demos",
@@ -81,6 +80,7 @@ const sidebars = {
8180
"demos/chatbox-vid",
8281
],
8382
},
83+
"new/faq",
8484
],
8585

8686
apiSidebar: [

0 commit comments

Comments
 (0)