Refactor Docs
This commit is contained in:
parent
f8657a8a31
commit
b98dfde7a7
@ -1,5 +0,0 @@
|
|||||||
---
|
|
||||||
title: Story
|
|
||||||
---
|
|
||||||
|
|
||||||
TODO: a month by month recap
|
|
||||||
@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
title: Team
|
|
||||||
---
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
{
|
|
||||||
"label": "Company",
|
|
||||||
"position": 2,
|
|
||||||
"link": {
|
|
||||||
"type": "generated-index"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"label": "Handbook",
|
"label": "Handbook",
|
||||||
"position": 5,
|
"position": 4,
|
||||||
"link": {
|
"link": {
|
||||||
"type": "generated-index"
|
"type": "generated-index"
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"label": "Roadmap",
|
"label": "Roadmap",
|
||||||
"position": 4,
|
"position": 3,
|
||||||
"link": {
|
"link": {
|
||||||
"type": "generated-index"
|
"type": "generated-index"
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"label": "Strategy",
|
"label": "Strategy",
|
||||||
"position": 3,
|
"position": 2,
|
||||||
"link": {
|
"link": {
|
||||||
"type": "generated-index"
|
"type": "generated-index"
|
||||||
}
|
}
|
||||||
|
|||||||
3
docs/docs/features/acceleration.md
Normal file
3
docs/docs/features/acceleration.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
title: Hardware Acceleration
|
||||||
|
---
|
||||||
3
docs/docs/features/extensions.md
Normal file
3
docs/docs/features/extensions.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
title: Extensions
|
||||||
|
---
|
||||||
5
docs/docs/features/features.md
Normal file
5
docs/docs/features/features.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 1
|
||||||
|
title: Overview
|
||||||
|
slug: /features
|
||||||
|
---
|
||||||
7
docs/docs/features/self-hosted.md
Normal file
7
docs/docs/features/self-hosted.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
title: Self-Hosted AI
|
||||||
|
---
|
||||||
|
|
||||||
|
- Privacy
|
||||||
|
- Offline-ready
|
||||||
|
- Fixed cost
|
||||||
@ -1,20 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 1
|
|
||||||
title: Getting Started
|
|
||||||
slug: /
|
|
||||||
---
|
|
||||||
|
|
||||||
Hi there
|
|
||||||
|
|
||||||
import Tabs from '@theme/Tabs';
|
|
||||||
import TabItem from '@theme/TabItem';
|
|
||||||
|
|
||||||
<Tabs groupId="operating-systems">
|
|
||||||
<TabItem value="win" label="Windows">Use Ctrl + C to copy.</TabItem>
|
|
||||||
<TabItem value="mac" label="macOS">Use Command + C to copy.</TabItem>
|
|
||||||
</Tabs>
|
|
||||||
|
|
||||||
<Tabs groupId="operating-systems">
|
|
||||||
<TabItem value="win" label="Windows">Use Ctrl + V to paste.</TabItem>
|
|
||||||
<TabItem value="mac" label="macOS">Use Command + V to paste.</TabItem>
|
|
||||||
</Tabs>
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 1
|
|
||||||
title: Glossary
|
|
||||||
---
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 1
|
|
||||||
title: Guides
|
|
||||||
---
|
|
||||||
|
|
||||||
TODO
|
|
||||||
7
docs/docs/guides/guides.md
Normal file
7
docs/docs/guides/guides.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 1
|
||||||
|
title: Getting Started
|
||||||
|
slug: /guides
|
||||||
|
---
|
||||||
|
|
||||||
|
TODO
|
||||||
6
docs/docs/guides/install/install.md
Normal file
6
docs/docs/guides/install/install.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 1
|
||||||
|
title: Installing Jan
|
||||||
|
slug: /install
|
||||||
|
---
|
||||||
|
|
||||||
3
docs/docs/guides/install/linux.md
Normal file
3
docs/docs/guides/install/linux.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
title: Installing Jan on Linux
|
||||||
|
---
|
||||||
3
docs/docs/guides/install/mac.md
Normal file
3
docs/docs/guides/install/mac.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
title: Installing Jan on Linux
|
||||||
|
---
|
||||||
3
docs/docs/guides/install/windows.md
Normal file
3
docs/docs/guides/install/windows.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
title: Installing Jan on Linux
|
||||||
|
---
|
||||||
@ -1,6 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 1
|
|
||||||
title: Integrations
|
|
||||||
---
|
|
||||||
|
|
||||||
TODO
|
|
||||||
3
docs/docs/platforms/desktop.md
Normal file
3
docs/docs/platforms/desktop.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
title: Jan Desktop
|
||||||
|
---
|
||||||
3
docs/docs/platforms/mobile.md
Normal file
3
docs/docs/platforms/mobile.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
title: Jan Mobile
|
||||||
|
---
|
||||||
4
docs/docs/platforms/platform.md
Normal file
4
docs/docs/platforms/platform.md
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: Platform
|
||||||
|
slug: /platform
|
||||||
|
---
|
||||||
3
docs/docs/platforms/server.md
Normal file
3
docs/docs/platforms/server.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
title: Jan Server
|
||||||
|
---
|
||||||
3
docs/docs/solutions/enterprise.md
Normal file
3
docs/docs/solutions/enterprise.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
title: Enterprise AI Platform
|
||||||
|
---
|
||||||
3
docs/docs/solutions/personal-ai.md
Normal file
3
docs/docs/solutions/personal-ai.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
title: Personal AI
|
||||||
|
---
|
||||||
4
docs/docs/solutions/solutions.md
Normal file
4
docs/docs/solutions/solutions.md
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: Solutions
|
||||||
|
slug: /solutions
|
||||||
|
---
|
||||||
@ -6,12 +6,12 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
|
|||||||
|
|
||||||
/** @type {import('@docusaurus/types').Config} */
|
/** @type {import('@docusaurus/types').Config} */
|
||||||
const config = {
|
const config = {
|
||||||
title: 'Jan Documentation',
|
title: 'Jan',
|
||||||
tagline: 'Self-hosted AI inference platform',
|
tagline: 'Run your own AI',
|
||||||
favicon: 'img/favicon.ico',
|
favicon: 'img/favicon.ico',
|
||||||
|
|
||||||
// Set the production url of your site here
|
// Set the production url of your site here
|
||||||
url: 'https://docs.jan.ai',
|
url: 'https://jan.ai',
|
||||||
// Set the /<baseUrl>/ pathname under which your site is served
|
// Set the /<baseUrl>/ pathname under which your site is served
|
||||||
// For GitHub pages deployment, it is often '/<projectName>/'
|
// For GitHub pages deployment, it is often '/<projectName>/'
|
||||||
baseUrl: '/',
|
baseUrl: '/',
|
||||||
@ -21,7 +21,7 @@ const config = {
|
|||||||
organizationName: 'janhq', // Usually your GitHub org/user name.
|
organizationName: 'janhq', // Usually your GitHub org/user name.
|
||||||
projectName: 'jan', // Usually your repo name.
|
projectName: 'jan', // Usually your repo name.
|
||||||
|
|
||||||
onBrokenLinks: 'ignore',
|
onBrokenLinks: 'warn',
|
||||||
onBrokenMarkdownLinks: 'warn',
|
onBrokenMarkdownLinks: 'warn',
|
||||||
|
|
||||||
// Even if you don't use internalization, you can use this field to set useful
|
// Even if you don't use internalization, you can use this field to set useful
|
||||||
@ -54,8 +54,8 @@ const config = {
|
|||||||
},
|
},
|
||||||
// Will be passed to @docusaurus/plugin-content-sitemap (false to disable)
|
// Will be passed to @docusaurus/plugin-content-sitemap (false to disable)
|
||||||
sitemap: {
|
sitemap: {
|
||||||
changefreq: 'weekly',
|
changefreq: 'daily',
|
||||||
priority: 0.5,
|
priority: 1.0,
|
||||||
ignorePatterns: ['/tags/**'],
|
ignorePatterns: ['/tags/**'],
|
||||||
filename: 'sitemap.xml',
|
filename: 'sitemap.xml',
|
||||||
},
|
},
|
||||||
@ -76,7 +76,7 @@ const config = {
|
|||||||
specs: [
|
specs: [
|
||||||
{
|
{
|
||||||
spec: 'openapi/OpenAPISpec.json', // can be local file, url, or parsed json object
|
spec: 'openapi/OpenAPISpec.json', // can be local file, url, or parsed json object
|
||||||
route: '/reference/',
|
route: '/api/',
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
theme: {
|
theme: {
|
||||||
@ -98,18 +98,18 @@ const config = {
|
|||||||
playgroundPosition: 'bottom',
|
playgroundPosition: 'bottom',
|
||||||
},
|
},
|
||||||
navbar: {
|
navbar: {
|
||||||
title: 'Jan Docs',
|
title: 'Jan',
|
||||||
logo: {
|
logo: {
|
||||||
alt: 'Jan Logo',
|
alt: 'Jan Logo',
|
||||||
src: 'img/logo.svg',
|
src: 'img/logo.svg',
|
||||||
},
|
},
|
||||||
items: [
|
items: [
|
||||||
// Navbar left
|
// Navbar Top
|
||||||
{
|
{
|
||||||
type: 'docSidebar',
|
type: 'docSidebar',
|
||||||
sidebarId: 'quickstartSidebar',
|
sidebarId: 'featuresSidebar',
|
||||||
position: 'left',
|
position: 'left',
|
||||||
label: 'Getting Started',
|
label: 'Features',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
type: 'docSidebar',
|
type: 'docSidebar',
|
||||||
@ -124,15 +124,9 @@ const config = {
|
|||||||
label: 'Hardware',
|
label: 'Hardware',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
type: 'docSidebar',
|
|
||||||
sidebarId: 'integrationsSidebar',
|
|
||||||
position: 'left',
|
position: 'left',
|
||||||
label: 'Integrations',
|
label: 'API',
|
||||||
},
|
to: '/api',
|
||||||
{
|
|
||||||
position: 'left',
|
|
||||||
label: 'Reference',
|
|
||||||
to: '/reference',
|
|
||||||
},
|
},
|
||||||
// Navbar right
|
// Navbar right
|
||||||
{
|
{
|
||||||
@ -167,8 +161,8 @@ const config = {
|
|||||||
to: '/developer',
|
to: '/developer',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'Reference',
|
label: 'API',
|
||||||
to: '/reference',
|
to: '/api',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'Changelog',
|
label: 'Changelog',
|
||||||
@ -183,13 +177,9 @@ const config = {
|
|||||||
label: 'Discord',
|
label: 'Discord',
|
||||||
href: 'https://discord.gg/FTk2MvZwJH',
|
href: 'https://discord.gg/FTk2MvZwJH',
|
||||||
},
|
},
|
||||||
{
|
|
||||||
label: 'Telegram',
|
|
||||||
href: 'https://t.me/+cSSlxwEM-0piMDQ1',
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
label: 'Twitter',
|
label: 'Twitter',
|
||||||
href: 'https://twitter.com/askjanai',
|
href: 'https://twitter.com/jan_dotai',
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|||||||
14177
docs/package-lock.json
generated
14177
docs/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@ -14,28 +14,71 @@
|
|||||||
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
||||||
const sidebars = {
|
const sidebars = {
|
||||||
// By default, Docusaurus generates a sidebar from the docs folder structure
|
// By default, Docusaurus generates a sidebar from the docs folder structure
|
||||||
quickstartSidebar: [{
|
// featuresSidebar: [{ type: 'autogenerated', dirName: 'features' }],
|
||||||
type: 'autogenerated', dirName: 'getting-started',
|
|
||||||
}],
|
|
||||||
guidesSidebar: [{ type: 'autogenerated', dirName: 'guides' }],
|
|
||||||
hardwareSidebar: [{ type: 'autogenerated', dirName: 'hardware' }],
|
hardwareSidebar: [{ type: 'autogenerated', dirName: 'hardware' }],
|
||||||
integrationsSidebar: [{ type: 'autogenerated', dirName: 'integrations' }],
|
|
||||||
glossarySidebar: [{ type: 'autogenerated', dirName: 'glossary' }],
|
|
||||||
changelogSidebar: [{ type: 'autogenerated', dirName: 'changelog' }],
|
|
||||||
aboutSidebar: [{ type: 'autogenerated', dirName: 'about' }],
|
aboutSidebar: [{ type: 'autogenerated', dirName: 'about' }],
|
||||||
|
|
||||||
// But you can create a sidebar manually
|
// But you can create a sidebar manually
|
||||||
/*
|
featuresSidebar: [
|
||||||
tutorialSidebar: [
|
'features/features',
|
||||||
'intro',
|
|
||||||
'hello',
|
|
||||||
{
|
{
|
||||||
type: 'category',
|
type: 'category',
|
||||||
label: 'Tutorial',
|
label: 'Platforms',
|
||||||
items: ['tutorial-basics/create-a-document'],
|
collapsible: true,
|
||||||
|
collapsed: true,
|
||||||
|
link: { type: 'doc', id: 'platforms/platform' },
|
||||||
|
items: [
|
||||||
|
'platforms/desktop',
|
||||||
|
'platforms/mobile',
|
||||||
|
'platforms/server'
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'category',
|
||||||
|
label: 'Features',
|
||||||
|
collapsible: true,
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
'features/self-hosted',
|
||||||
|
'features/acceleration',
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'category',
|
||||||
|
label: 'Solutions',
|
||||||
|
collapsible: true,
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
'solutions/personal-ai',
|
||||||
|
'solutions/enterprise'
|
||||||
|
]
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
*/
|
|
||||||
|
guidesSidebar: [
|
||||||
|
{ type: 'doc', label: "Overview", id: 'guides/guides' },
|
||||||
|
{
|
||||||
|
type: 'category',
|
||||||
|
label: 'Install',
|
||||||
|
collapsible: true,
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
{ type: 'doc', label: 'Overview', id: 'guides/install/install' },
|
||||||
|
{ type: 'doc', label: 'Windows', id: 'guides/install/windows' },
|
||||||
|
{ type: 'doc', label: 'Mac', id: 'guides/install/mac' },
|
||||||
|
{ type: 'doc', label: 'Linux', id: 'guides/install/linux' },
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'category',
|
||||||
|
label: 'Running as Server',
|
||||||
|
collapsible: true,
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
{ type: 'doc', label: 'Overview', id: 'guides/install/install' },
|
||||||
|
]
|
||||||
|
},
|
||||||
|
]
|
||||||
};
|
};
|
||||||
|
|
||||||
module.exports = sidebars;
|
module.exports = sidebars;
|
||||||
|
|||||||
41
docs/src/pages/index.js
Normal file
41
docs/src/pages/index.js
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import clsx from 'clsx';
|
||||||
|
import Link from '@docusaurus/Link';
|
||||||
|
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
||||||
|
import Layout from '@theme/Layout';
|
||||||
|
import HomepageFeatures from '@site/src/components/HomepageFeatures';
|
||||||
|
|
||||||
|
import styles from './index.module.css';
|
||||||
|
|
||||||
|
function HomepageHeader() {
|
||||||
|
const {siteConfig} = useDocusaurusContext();
|
||||||
|
return (
|
||||||
|
<header className={clsx('hero hero--primary', styles.heroBanner)}>
|
||||||
|
<div className="container">
|
||||||
|
<h1 className="hero__title">{siteConfig.title}</h1>
|
||||||
|
<p className="hero__subtitle">{siteConfig.tagline}</p>
|
||||||
|
<div className={styles.buttons}>
|
||||||
|
<Link
|
||||||
|
className="button button--secondary button--lg"
|
||||||
|
to="/docs/intro">
|
||||||
|
Docusaurus Tutorial - 5min ⏱️
|
||||||
|
</Link>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export default function Home() {
|
||||||
|
const {siteConfig} = useDocusaurusContext();
|
||||||
|
return (
|
||||||
|
<Layout
|
||||||
|
title={`Hello from ${siteConfig.title}`}
|
||||||
|
description="Description will go into a meta tag in <head />">
|
||||||
|
<HomepageHeader />
|
||||||
|
<main>
|
||||||
|
<HomepageFeatures />
|
||||||
|
</main>
|
||||||
|
</Layout>
|
||||||
|
);
|
||||||
|
}
|
||||||
Loading…
x
Reference in New Issue
Block a user