From 00726e7b25a35a6d4dd4efbee17a19c8263f5a66 Mon Sep 17 00:00:00 2001 From: Arista Indrajaya Date: Mon, 4 Mar 2024 16:43:09 +0700 Subject: [PATCH] docs: fix href ink --- docs/docs/guides/install.mdx | 54 ++++++++++++++++----------------- docs/docs/guides/quickstart.mdx | 4 +-- 2 files changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/docs/guides/install.mdx b/docs/docs/guides/install.mdx index cc4a1fcec..782f465ce 100644 --- a/docs/docs/guides/install.mdx +++ b/docs/docs/guides/install.mdx @@ -44,7 +44,7 @@ import installImageURL from './assets/jan-ai-download.png'; :::warning -If you are stuck in a broken build, go to the [Broken Build](/quickstart/common-error/broken-build) section of Common Errors. +If you are stuck in a broken build, go to the [Broken Build](/guides/common-error/broken-build) section of Common Errors. ::: @@ -86,7 +86,7 @@ If you are stuck in a broken build, go to the [Broken Build](/quickstart/common- :::warning -If you are stuck in a broken build, go to the [Broken Build](/quickstart/common-error/broken-build) section of Common Errors. +If you are stuck in a broken build, go to the [Broken Build](/guides/common-error/broken-build) section of Common Errors. ::: @@ -154,7 +154,7 @@ If you are stuck in a broken build, go to the [Broken Build](/quickstart/common- :::warning -If you are stuck in a broken build, go to the [Broken Build](/quickstart/common-error/broken-build) section of Common Errors. +If you are stuck in a broken build, go to the [Broken Build](/guides/common-error/broken-build) section of Common Errors. ::: @@ -174,29 +174,6 @@ If you are stuck in a broken build, go to the [Broken Build](/quickstart/common- - If you have not installed the required file for GPU support, follow the instructions [here](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html). ::: - ### Docker Compose Profile and Environment - Before dive in into the steps to run Jan in Docker, ensure that you have understand the following docker compose profile and the environment variable listed below: - - #### Docker Compose Profile - - | Profile | Description | - |-----------|-------------------------------------------| - | cpu-fs | Run Jan in CPU mode with default file system | - | cpu-s3fs | Run Jan in CPU mode with S3 file system | - | gpu-fs | Run Jan in GPU mode with default file system | - | gpu-s3fs | Run Jan in GPU mode with S3 file system | - - #### Environment Variables - - | Environment Variable | Description | - |--------------------------|------------------------------------------------------------| - | S3_BUCKET_NAME | S3 bucket name - leave blank for default file system | - | AWS_ACCESS_KEY_ID | AWS access key ID - leave blank for default file system | - | AWS_SECRET_ACCESS_KEY | AWS secret access key - leave blank for default file system| - | AWS_ENDPOINT | AWS endpoint URL - leave blank for default file system | - | AWS_REGION | AWS region - leave blank for default file system | - | API_BASE_URL | Jan Server URL, please modify it as your public ip address or domain name default http://localhost:1377 | - ### Run Jan in Docker You can run Jan in Docker with two methods: 1. Run Jan in CPU mode @@ -263,10 +240,33 @@ If you are stuck in a broken build, go to the [Broken Build](/quickstart/common- + ### Docker Compose Profile and Environment + The available Docker Compose profile and the environment variables listed below: + + #### Docker Compose Profile + + | Profile | Description | + |-----------|-------------------------------------------| + | cpu-fs | Run Jan in CPU mode with default file system | + | cpu-s3fs | Run Jan in CPU mode with S3 file system | + | gpu-fs | Run Jan in GPU mode with default file system | + | gpu-s3fs | Run Jan in GPU mode with S3 file system | + + #### Environment Variables + + | Environment Variable | Description | + |--------------------------|------------------------------------------------------------| + | S3_BUCKET_NAME | S3 bucket name - leave blank for default file system | + | AWS_ACCESS_KEY_ID | AWS access key ID - leave blank for default file system | + | AWS_SECRET_ACCESS_KEY | AWS secret access key - leave blank for default file system| + | AWS_ENDPOINT | AWS endpoint URL - leave blank for default file system | + | AWS_REGION | AWS region - leave blank for default file system | + | API_BASE_URL | Jan Server URL, please modify it as your public ip address or domain name default http://localhost:1377 | + :::warning -If you are stuck in a broken build, go to the [Broken Build](/quickstart/common-error/broken-build/) section of Common Errors. +If you are stuck in a broken build, go to the [Broken Build](/guides/common-error/broken-build/) section of Common Errors. ::: diff --git a/docs/docs/guides/quickstart.mdx b/docs/docs/guides/quickstart.mdx index bf4c9b4fe..84612716a 100644 --- a/docs/docs/guides/quickstart.mdx +++ b/docs/docs/guides/quickstart.mdx @@ -50,7 +50,7 @@ To get started quickly with Jan, follow the steps below: Go to [Jan.ai](https://jan.ai/) > Select your operating system > Install the program. :::note -To learn more about system requirements for your operating system, go to [Installation guide](/quickstart/install). +To learn more about system requirements for your operating system, go to [Installation guide](/guides/install). ::: ### Step 2: Select AI Model @@ -60,7 +60,7 @@ Before using Jan, you need to select an AI model that based on your hardware cap Go to the **Hub** > select the models that you would like to install. :::note -For more info, go to [list of supported models](/quickstart/models-list/). +For more info, go to [list of supported models](/guides/models-list/). ::: ### Step 3: Use the AI Model