From e7722e41590a184604b1867654af19dd1249d291 Mon Sep 17 00:00:00 2001 From: hieu-jan <150573299+hieu-jan@users.noreply.github.com> Date: Fri, 16 Feb 2024 07:10:25 +0700 Subject: [PATCH] docs: rename image file and format documentation --- docs/docs/guides/05-using-server/01-start-server.md | 11 +++++------ docs/docs/guides/05-using-server/02-using-server.md | 6 +++--- .../{choose-model.png => 01-choose-model.png} | Bin .../{local-api-view.png => 01-local-api-view.png} | Bin .../{running-server.png => 01-running-server.png} | Bin .../{server-settings.png => 01-server-settings.png} | Bin .../{api-reference.png => 02-api-reference.png} | Bin .../{chat-example.png => 02-chat-example.png} | Bin 8 files changed, 8 insertions(+), 9 deletions(-) rename docs/docs/guides/05-using-server/assets/{choose-model.png => 01-choose-model.png} (100%) rename docs/docs/guides/05-using-server/assets/{local-api-view.png => 01-local-api-view.png} (100%) rename docs/docs/guides/05-using-server/assets/{running-server.png => 01-running-server.png} (100%) rename docs/docs/guides/05-using-server/assets/{server-settings.png => 01-server-settings.png} (100%) rename docs/docs/guides/05-using-server/assets/{api-reference.png => 02-api-reference.png} (100%) rename docs/docs/guides/05-using-server/assets/{chat-example.png => 02-chat-example.png} (100%) diff --git a/docs/docs/guides/05-using-server/01-start-server.md b/docs/docs/guides/05-using-server/01-start-server.md index 9576dd6e2..649eab423 100644 --- a/docs/docs/guides/05-using-server/01-start-server.md +++ b/docs/docs/guides/05-using-server/01-start-server.md @@ -23,15 +23,15 @@ Navigate by clicking the `Local API Server` icon on the left side of your screen

-![local-api-view](./assets/local-api-view.png) +![01-local-api-view](./assets/01-local-api-view.png) ## Choose your model -On the top right of your screen under `Model Settings`, set the LLM that your local server will be running. You can choose from any of the models already installed, or pick a new model by clicking `Explore the Hub`. +On the top right of your screen under `Model Settings`, set the LLM that your local server will be running. You can choose from any of the models already installed, or pick a new model by clicking `Explore the Hub`.

-![choose-model](./assets/choose-model.png) +![01-choose-model](./assets/01-choose-model.png) ## Set your Server Options @@ -39,7 +39,7 @@ On the left side of your screen you can set custom server options.

-![server-settings](./assets/server-settings.png) +![01-server-settings](./assets/01-server-settings.png) ### Local Server Address @@ -65,7 +65,6 @@ Click the `Start Server` button on the top left of your screen. You will see the

-![running-server](./assets/running-server.png) +![01-running-server](./assets/01-running-server.png) Your server is now running. Next, learn how to use your local API server. - diff --git a/docs/docs/guides/05-using-server/02-using-server.md b/docs/docs/guides/05-using-server/02-using-server.md index 2ac0480fa..e01fd1af2 100644 --- a/docs/docs/guides/05-using-server/02-using-server.md +++ b/docs/docs/guides/05-using-server/02-using-server.md @@ -24,7 +24,7 @@ On the top left of your screen below the red `Stop Server` button is the blue `A

-![api-reference](./assets/api-reference.png) +![02-api-reference](./assets/02-api-reference.png) Scroll through the various available endpoints to learn what options are available. @@ -34,7 +34,7 @@ In the Chat section of the API reference, you will see an example JSON request b

-![chat-example](./assets/chat-example.png) +![02-chat-example](./assets/02-chat-example.png) With your local server running, you can click the `Try it out` button on the top left, then the blue `Execute` button below the JSON. The browser will send the example request to your server, and display the response body below. @@ -100,4 +100,4 @@ curl -X 'POST' \ "total_tokens": 533 } } -``` \ No newline at end of file +``` diff --git a/docs/docs/guides/05-using-server/assets/choose-model.png b/docs/docs/guides/05-using-server/assets/01-choose-model.png similarity index 100% rename from docs/docs/guides/05-using-server/assets/choose-model.png rename to docs/docs/guides/05-using-server/assets/01-choose-model.png diff --git a/docs/docs/guides/05-using-server/assets/local-api-view.png b/docs/docs/guides/05-using-server/assets/01-local-api-view.png similarity index 100% rename from docs/docs/guides/05-using-server/assets/local-api-view.png rename to docs/docs/guides/05-using-server/assets/01-local-api-view.png diff --git a/docs/docs/guides/05-using-server/assets/running-server.png b/docs/docs/guides/05-using-server/assets/01-running-server.png similarity index 100% rename from docs/docs/guides/05-using-server/assets/running-server.png rename to docs/docs/guides/05-using-server/assets/01-running-server.png diff --git a/docs/docs/guides/05-using-server/assets/server-settings.png b/docs/docs/guides/05-using-server/assets/01-server-settings.png similarity index 100% rename from docs/docs/guides/05-using-server/assets/server-settings.png rename to docs/docs/guides/05-using-server/assets/01-server-settings.png diff --git a/docs/docs/guides/05-using-server/assets/api-reference.png b/docs/docs/guides/05-using-server/assets/02-api-reference.png similarity index 100% rename from docs/docs/guides/05-using-server/assets/api-reference.png rename to docs/docs/guides/05-using-server/assets/02-api-reference.png diff --git a/docs/docs/guides/05-using-server/assets/chat-example.png b/docs/docs/guides/05-using-server/assets/02-chat-example.png similarity index 100% rename from docs/docs/guides/05-using-server/assets/chat-example.png rename to docs/docs/guides/05-using-server/assets/02-chat-example.png