docs: Update broken link and fix the slug (#2260)
docs: Update broken link and fix the slug
This commit is contained in:
commit
e2e3ae74fa
@ -23,21 +23,21 @@ Jan is a versatile platform offering solutions for integrating AI locally across
|
||||
The [quickstart guide](quickstart.mdx) is designed to facilitate a quick setup process. It provides a clear instruction and simple steps to get you up and running with Jan.ai quickly. Even, if you are inexperienced in AI, the quickstart can offer valuable insights and tips to help you get started quickly.
|
||||
|
||||
## Setting up the Right Models
|
||||
Jan offers a range of pre-configured AI models that is tailored to different tasks and industries. You should indentify which on that aligns with your objectives. There are model's factors to be considered:
|
||||
Jan offers a range of pre-configured AI models that are tailored to different tasks and industries. You should identify which on that aligns with your objectives. There are factors to be considered:
|
||||
- Capabilities
|
||||
- Accuracy
|
||||
- Processing Speed
|
||||
|
||||
:::note
|
||||
Some of these factors also depends on your hardware, please see [Hardware Requirement](hardware-requiement.mdx).
|
||||
- Some of these factors also depend on your hardware, please see Hardware Requirement.
|
||||
- Choosing the right model is important to achieve the best performance.
|
||||
:::
|
||||
Choosing the right model is important to achieve the best performance.
|
||||
|
||||
## Setting up Jan
|
||||
Ensure that you familiarize yourself with the Jan application. Jan offers advanced settings that you can adjust. These settings may influence how your AI behaves locally. Please see the [Advanced Settings](./advanced-settings/advanced-settings.mdx) article for a complete list of Jan's configurations and instructions on how to configure them.
|
||||
|
||||
## Integrations
|
||||
One of Jan.ai key features is its ability to integrate with many FileSystemWritableFileStream. Whether you are incorporating Jan.ai with any open-source LLM provider or other WebTransportBidirectionalStream, it is important to understand the integration capabilities and limitations.
|
||||
One of Jan's key features is its ability to integrate with many systems. Whether you are incorporating Jan.ai with any open-source LLM provider or other tools, it is important to understand the integration capabilities and limitations.
|
||||
|
||||
## Mastering the Prompt Engineering
|
||||
Prompt engineering is an important aspect when dealing with AI models to generate the desired outputs. Mastering this skill can significantly enhance the performance and the responses of the AI. Below are some tips that you can do for prompt engineering:
|
||||
@ -45,4 +45,4 @@ Prompt engineering is an important aspect when dealing with AI models to generat
|
||||
- Be specific and details get a more specific answers
|
||||
- Provide examples or preference text or context at the beginning
|
||||
- Use a clear and concise language
|
||||
- Use a certain keywords and phrases
|
||||
- Use certain keywords and phrases
|
||||
|
||||
49
docs/docs/guides/error-codes/how-to-get-error-logs.mdx
Normal file
49
docs/docs/guides/error-codes/how-to-get-error-logs.mdx
Normal file
@ -0,0 +1,49 @@
|
||||
---
|
||||
title: How to Get Error Logs
|
||||
sidebar_position: 5
|
||||
description: A step-by-step guide to get the Jan app error logs.
|
||||
keywords:
|
||||
[
|
||||
Jan AI,
|
||||
Jan,
|
||||
ChatGPT alternative,
|
||||
local AI,
|
||||
private AI,
|
||||
conversational AI,
|
||||
no-subscription fee,
|
||||
large language model,
|
||||
troubleshooting,
|
||||
permission denied,
|
||||
]
|
||||
---
|
||||
|
||||
To get the error logs of your Jan application, follow the steps below:
|
||||
### Jan Application
|
||||
1. Navigate to the main dashboard.
|
||||
2. Click the **gear icon (⚙️)** on the bottom left of your screen.
|
||||
3. Under the **Settings screen**, click the **Advanced Settings**.
|
||||
4. On the **Jan Data Folder** click the **folder icon (📂)** to access the data.
|
||||
5. Click the **logs** folder.
|
||||
|
||||
### Jan UI
|
||||
1. Open your Unix or Linux terminal.
|
||||
2. Use the following commands to get the recent 50 lines of log files:
|
||||
```bash
|
||||
tail -n 50 ~/jan/logs/app.log
|
||||
|
||||
```
|
||||
|
||||
### Jan API Server
|
||||
1. Open your Unix or Linux terminal.
|
||||
2. Use the following commands to get the recent 50 lines of log files:
|
||||
```bash
|
||||
tail -n 50 ~/jan/logs/server.log
|
||||
|
||||
```
|
||||
:::warning
|
||||
Ensure to redact any private or sensitive information when sharing logs or error details.
|
||||
:::
|
||||
|
||||
:::note
|
||||
If you have any questions or are looking for support, please don't hesitate to contact us via our [Discord community](https://discord.gg/Dt7MxDyNNZ) or create a new issue in our [GitHub repository](https://github.com/janhq/jan/issues/new/choose).
|
||||
:::
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Manual Import
|
||||
slug: /guides/using-models/import-manually/
|
||||
sidebar_position: 3
|
||||
description: A step-by-step guide on how to perform manual import feature.
|
||||
keywords:
|
||||
|
||||
@ -5,58 +5,45 @@ hide_table_of_contents: true
|
||||
description: Manage your interaction with AI locally.
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
Jan provides a straightforward and private solution for managing your threads with AI on your own device. As you interact with AI using Jan, you'll accumulate a history of threads.
|
||||
Jan offers easy tools to organize, delete, or review your past threads with AI. This guide will show you how to keep your threads private and well-organized.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="view" label = "View Thread History" default>
|
||||
|
||||
### View Thread History
|
||||
To view your threads history, follow the steps below:
|
||||
To view your thread history, follow the steps below:
|
||||
1. Navigate to the main dashboard.
|
||||
2. Locate the list of threads screen on the left side.
|
||||
3. To view a specific thread, simply choose the one you're interested in and then scroll up or down to explore the entire conversation.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value = "manage" label = "Managing Threads">
|
||||
|
||||
### Manage the Threads via Folder
|
||||
To manage your threads history and configurations, follow the steps below:
|
||||
### Manage Thread via Jan Data Folder
|
||||
To manage your thread history and configurations, follow the steps below:
|
||||
1. Navigate to the Thread that you want to manage via the list of threads on the left side of the dashboard.
|
||||
2. Click on the **three dots (⋮)** on the Thread section.
|
||||
2. Click on the **three dots (⋮)** in the Thread section.
|
||||
3. There are two available options to select:
|
||||
- **Reveal in Finder**: Opens the folder containing the thread history and configurations.
|
||||
- **View as JSON**: Opens the thread.json file in your default browser.
|
||||
|
||||
|
||||
</TabItem>
|
||||
<TabItem value = "clean" label = "Clean Threads">
|
||||
|
||||
### Clean Threads History
|
||||
To clean all the messages from a thread, follow the steps below:
|
||||
1. Navigate to the Thread that you want to clean.
|
||||
2. Click on the **three dots (⋮)** on the Thread section.
|
||||
2. Click on the **three dots (⋮)** in the Thread section.
|
||||
3. Sleect the **Clean Thread** button.
|
||||
|
||||
:::note
|
||||
This will delete all messages in the thread, while keeping the thread settings.
|
||||
This will delete all messages in the thread while keeping the thread settings.
|
||||
:::
|
||||
</TabItem>
|
||||
<TabItem value="delete" label = "Delete Thread" default>
|
||||
|
||||
|
||||
### Delete Threads History
|
||||
To delete a thread, follow the steps below:
|
||||
1. Navigate to the Thread that you want to delete.
|
||||
2. Click on the **three dots (⋮)** on the Thread section.
|
||||
2. Click on the **three dots (⋮)** in the Thread section.
|
||||
3. Sleect the **Delete Thread** button.
|
||||
|
||||
|
||||
:::note
|
||||
This will delete all messages and the thread settings.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Changelog
|
||||
slug: /guides/changelog/
|
||||
sidebar_position: 5
|
||||
sidebar_position: 1
|
||||
slug: /changelog
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords:
|
||||
[
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 16
|
||||
slug: /changelog/changelog-v0.2.0
|
||||
---
|
||||
# v0.2.0
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 15
|
||||
slug: /changelog/changelog-v0.2.1
|
||||
---
|
||||
# v0.2.1
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 14
|
||||
slug: /changelog/changelog-v0.2.2
|
||||
---
|
||||
# v0.2.2
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 13
|
||||
slug: /changelog/changelog-v0.2.3
|
||||
---
|
||||
# v0.2.3
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 12
|
||||
slug: /changelog/changelog-v0.3.0
|
||||
---
|
||||
# v0.3.0
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 11
|
||||
slug: /changelog/changelog-v0.3.1
|
||||
---
|
||||
# v0.3.1
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
slug: /changelog/changelog-v0.3.2
|
||||
---
|
||||
# v0.3.2
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
slug: /changelog/changelog-v0.3.3
|
||||
---
|
||||
# v0.3.3
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
slug: /changelog/changelog-v0.4.0
|
||||
---
|
||||
# v0.4.0
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
slug: /changelog/changelog-v0.4.1
|
||||
---
|
||||
# v0.4.1
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
slug: /changelog/changelog-v0.4.2
|
||||
---
|
||||
# v0.4.2
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
slug: /changelog/changelog-v0.4.3
|
||||
---
|
||||
# v0.4.3
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
slug: /changelog/changelog-v0.4.4
|
||||
---
|
||||
# v0.4.4
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
slug: /changelog/changelog-v0.4.5
|
||||
---
|
||||
# v0.4.5
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
slug: /changelog/changelog-v0.4.6
|
||||
---
|
||||
# v0.4.6
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
slug: /changelog/changelog-v0.4.7
|
||||
---
|
||||
# v0.4.7
|
||||
|
||||
@ -74,6 +74,38 @@ const config = {
|
||||
from: "/guides/troubleshooting/gpu-not-used/",
|
||||
to: "/guides/common-error/not-using-gpu/",
|
||||
},
|
||||
{
|
||||
from: "/guides/troubleshooting/",
|
||||
to: "/guides/error-codes/",
|
||||
},
|
||||
{
|
||||
from: "/troubleshooting/stuck-on-broken-build/",
|
||||
to: "/guides/common-error/broken-build/",
|
||||
},
|
||||
{
|
||||
from: "/guides/troubleshooting/",
|
||||
to: "/guides/error-codes/",
|
||||
},
|
||||
{
|
||||
from: "/troubleshooting/somethings-amiss/",
|
||||
to: "/guides/error-codes/something-amiss/",
|
||||
},
|
||||
{
|
||||
from: "/troubleshooting/how-to-get-error-logs/",
|
||||
to: "/guides/error-codes/how-to-get-error-logs/",
|
||||
},
|
||||
{
|
||||
from: "/troubleshooting/permission-denied/",
|
||||
to: "/guides/error-codes/permission-denied/",
|
||||
},
|
||||
{
|
||||
from: "/troubleshooting/unexpected-token/",
|
||||
to: "/guides/error-codes/unexpected-token/",
|
||||
},
|
||||
{
|
||||
from: "/troubleshooting/undefined-issue/",
|
||||
to: "/guides/error-codes/undefined-issue/",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
@ -299,7 +331,7 @@ const config = {
|
||||
{
|
||||
type: "docSidebar",
|
||||
sidebarId: "guidesSidebar",
|
||||
label: "User Guide",
|
||||
label: "Guides",
|
||||
},
|
||||
{
|
||||
type: "docSidebar",
|
||||
@ -310,6 +342,11 @@ const config = {
|
||||
to: "/api-reference",
|
||||
label: "API Reference",
|
||||
},
|
||||
{
|
||||
type: "docSidebar",
|
||||
sidebarId: "releasesSidebar",
|
||||
label: "Changelog",
|
||||
},
|
||||
// {
|
||||
// type: "docSidebar",
|
||||
// sidebarId: "docsSidebar",
|
||||
@ -343,10 +380,6 @@ const config = {
|
||||
},
|
||||
},
|
||||
|
||||
customFields: {
|
||||
githubAccessToken: process.env.GITHUB_ACCESS_TOKEN || "XXXX",
|
||||
},
|
||||
|
||||
themes: ["@docusaurus/theme-live-codeblock", "@docusaurus/theme-mermaid"],
|
||||
};
|
||||
|
||||
|
||||
@ -162,6 +162,12 @@ const sidebars = {
|
||||
dirName: "developer",
|
||||
},
|
||||
],
|
||||
releasesSidebar: [
|
||||
{
|
||||
type: "autogenerated",
|
||||
dirName: "releases",
|
||||
},
|
||||
]
|
||||
};
|
||||
|
||||
module.exports = sidebars;
|
||||
|
||||
BIN
docs/src/theme/DocCard/assets/logs-error.png
Normal file
BIN
docs/src/theme/DocCard/assets/logs-error.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.6 KiB |
@ -45,6 +45,7 @@ import gpu from './assets/gpu.png';
|
||||
import mistral from './assets/mistral.png';
|
||||
import lm from './assets/lm.png';
|
||||
import ollama from './assets/ollama.png';
|
||||
import logsError from './assets/logs-error.png';
|
||||
|
||||
function CardContainer({href, children}) {
|
||||
return (
|
||||
@ -166,7 +167,7 @@ function CardLink({item}) {
|
||||
<img src={amiss} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} />
|
||||
) : (item.label === "Broken Build") ? (
|
||||
<img src={broken} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} />
|
||||
) : (item.label === "Jan not using GPU") ? (
|
||||
) : (item.label === "Troubleshooting NVIDIA GPU") ? (
|
||||
<img src={gpu} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} />
|
||||
) : (item.label === "Mistral AI") ? (
|
||||
<img src={mistral} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} />
|
||||
@ -174,10 +175,15 @@ function CardLink({item}) {
|
||||
<img src={lm} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} />
|
||||
) : (item.label === "Ollama") ? (
|
||||
<img src={ollama} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} />
|
||||
) : (item.label === "How to Get Error Logs") ? (
|
||||
<img src={logsError} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} />
|
||||
) : (
|
||||
// If not "Customize Engine Settings", use default icon
|
||||
'📄️'
|
||||
);
|
||||
|
||||
|
||||
|
||||
const doc = useDocById(item.docId ?? undefined);
|
||||
return (
|
||||
<CardLayout
|
||||
|
||||
@ -17,7 +17,7 @@ import styles from "./styles.module.scss";
|
||||
import NavBarExtension from "../NavbarExtension";
|
||||
import { useLocation } from "react-router-dom";
|
||||
|
||||
const allowedPaths = ["/docs/", "/developer/", "/api-reference/", "/guides/", "/guides", "/docs", "/developer", "/api-reference", "/guides/changelog"];
|
||||
const allowedPaths = ["/docs/", "/developer/", "/api-reference/", "/guides/", "/guides", "/docs", "/developer", "/api-reference", "/changelog"];
|
||||
|
||||
export default function Layout(props) {
|
||||
const {
|
||||
|
||||
@ -17,9 +17,9 @@ export default function NavBarExtension() {
|
||||
<NavLink
|
||||
to="/guides"
|
||||
className="text-gray-700 font-medium hover:text-gray-900 dark:text-gray-300 dark:hover:text-gray-200"
|
||||
activeClassName={location.pathname !== "/guides/changelog" && location.pathname === "/guides" ? "text-gray-900 dark:text-gray-100 font-semibold border-b-2 border-gray-900 dark:border-gray-100" : ""}
|
||||
activeClassName="text-gray-900 dark:text-gray-100 font-bold border-b-2 border-gray-900 dark:border-gray-100"
|
||||
>
|
||||
Guide
|
||||
Guides
|
||||
</NavLink>
|
||||
<NavLink
|
||||
to="/developer"
|
||||
@ -36,9 +36,9 @@ export default function NavBarExtension() {
|
||||
API Reference
|
||||
</NavLink>
|
||||
<NavLink
|
||||
to="/guides/changelog"
|
||||
to="/changelog"
|
||||
className="text-gray-700 font-medium hover:text-gray-900 dark:text-gray-300 dark:hover:text-gray-200"
|
||||
activeClassName={location.pathname === "/guides/changelog" ? "text-gray-900 dark:text-gray-100 font-semibold border-b-2 border-gray-900 dark:border-gray-100" : ""}
|
||||
activeClassName="text-gray-900 dark:text-gray-100 font-bold border-b-2 border-gray-900 dark:border-gray-100"
|
||||
>
|
||||
Changelog
|
||||
</NavLink>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user