Refactor About Section
This commit is contained in:
parent
86d8d9c74c
commit
d47d43afbf
@ -1,4 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 1
|
|
||||||
title: About Jan
|
|
||||||
---
|
|
||||||
8
docs/docs/about/about.md
Normal file
8
docs/docs/about/about.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
---
|
||||||
|
title: About Jan
|
||||||
|
slug: /about
|
||||||
|
---
|
||||||
|
|
||||||
|
## Team
|
||||||
|
|
||||||
|
## History
|
||||||
3
docs/docs/about/brand-assets.md
Normal file
3
docs/docs/about/brand-assets.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
title: Brand Assets
|
||||||
|
---
|
||||||
@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
title: Team Structure
|
|
||||||
---
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
{
|
|
||||||
"label": "Handbook",
|
|
||||||
"position": 4,
|
|
||||||
"link": {
|
|
||||||
"type": "generated-index"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
10
docs/docs/about/roadmap.md
Normal file
10
docs/docs/about/roadmap.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
title: Roadmap
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
## Problem
|
||||||
|
|
||||||
|
## Ideal Customer Persona
|
||||||
|
|
||||||
|
## Business Model
|
||||||
@ -1,7 +0,0 @@
|
|||||||
{
|
|
||||||
"label": "Roadmap",
|
|
||||||
"position": 3,
|
|
||||||
"link": {
|
|
||||||
"type": "generated-index"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
title: Roadmap
|
|
||||||
---
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
---
|
|
||||||
title: Mission & Vision
|
|
||||||
---
|
|
||||||
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
---
|
|
||||||
title: Customer Persona
|
|
||||||
---
|
|
||||||
|
|
||||||
@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
title: Business Model
|
|
||||||
---
|
|
||||||
@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
title: Brand
|
|
||||||
---
|
|
||||||
@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
title: OKRs
|
|
||||||
---
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
{
|
|
||||||
"label": "Strategy",
|
|
||||||
"position": 2,
|
|
||||||
"link": {
|
|
||||||
"type": "generated-index"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
4
docs/docs/handbook/handbook.md
Normal file
4
docs/docs/handbook/handbook.md
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: Company Handbook
|
||||||
|
slug: /handbook
|
||||||
|
---
|
||||||
@ -2,22 +2,61 @@
|
|||||||
title: Recommended AI Hardware by Use Case
|
title: Recommended AI Hardware by Use Case
|
||||||
---
|
---
|
||||||
|
|
||||||
## Entry-level Experimentation
|
|
||||||
|
|
||||||
## Personal Use
|
## Personal Use
|
||||||
|
|
||||||
- Macbook (8gb)
|
### Entry-level Experimentation
|
||||||
|
|
||||||
## Prosumer Use
|
### Personal Use
|
||||||
|
|
||||||
|
- Macbook (16gb)
|
||||||
|
- 3090
|
||||||
|
|
||||||
|
### Prosumer Use
|
||||||
|
|
||||||
- Apple Silicon
|
- Apple Silicon
|
||||||
|
- 2 x 3090 (48gb RAM)
|
||||||
|
|
||||||
## For a 10-person Small Business
|
## Business Use
|
||||||
|
|
||||||
## For a 50-person Business
|
### For a 10-person Small Business
|
||||||
|
|
||||||
## For a Software Engineering Team
|
Run a LLM trained on enterprise data (i.e. RAG)
|
||||||
|
|
||||||
|
- Mac Studio M2 Ultra with 192GB unified memory
|
||||||
|
- Cannot train
|
||||||
|
- RTX 6000
|
||||||
|
- Should we recommend 2 x 4090 instead?
|
||||||
|
|
||||||
|
### For a 50-person Law Firm
|
||||||
|
|
||||||
|
- LLM, PDF Parsing, OCR
|
||||||
|
- Audit logging and compliance
|
||||||
|
|
||||||
|
### For a 1,000-student School
|
||||||
|
|
||||||
|
- Llama2 with safeguards
|
||||||
|
- RAG with textbook data
|
||||||
|
- Policy engine
|
||||||
|
|
||||||
|
## Software Engineering
|
||||||
|
|
||||||
|
### Personal Code Assistant
|
||||||
|
|
||||||
|
- Llama34b, needs adequate RAM
|
||||||
|
- Not recommended to run on local device due to RAM
|
||||||
|
|
||||||
|
### For a 10 person Software Team
|
||||||
|
|
||||||
|
Run Codellama with RAG on existing codebase
|
||||||
|
|
||||||
- Codellama34b
|
- Codellama34b
|
||||||
|
- RTX 6000s (48gb)
|
||||||
|
|
||||||
## For a 1000-person Enterprise
|
## Enterprise
|
||||||
|
|
||||||
|
### For a 1000-person Enterprise
|
||||||
|
|
||||||
|
### For a 10,000-person Enterprise
|
||||||
|
|
||||||
|
- 8 x H100s
|
||||||
|
- NVAIE with vGPUs
|
||||||
@ -1,68 +1,67 @@
|
|||||||
// @ts-check
|
// @ts-check
|
||||||
// Note: type annotations allow type checking and IDEs autocompletion
|
// Note: type annotations allow type checking and IDEs autocompletion
|
||||||
|
|
||||||
const lightCodeTheme = require('prism-react-renderer/themes/github');
|
const lightCodeTheme = require("prism-react-renderer/themes/github");
|
||||||
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
|
const darkCodeTheme = require("prism-react-renderer/themes/dracula");
|
||||||
|
|
||||||
/** @type {import('@docusaurus/types').Config} */
|
/** @type {import('@docusaurus/types').Config} */
|
||||||
const config = {
|
const config = {
|
||||||
title: 'Jan',
|
title: "Jan",
|
||||||
tagline: 'Run your own AI',
|
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://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: "/",
|
||||||
|
|
||||||
// GitHub pages deployment config.
|
// GitHub pages deployment config.
|
||||||
// If you aren't using GitHub pages, you don't need these.
|
// If you aren't using GitHub pages, you don't need these.
|
||||||
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: 'warn',
|
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
|
||||||
// metadata like html lang. For example, if your site is Chinese, you may want
|
// metadata like html lang. For example, if your site is Chinese, you may want
|
||||||
// to replace "en" with "zh-Hans".
|
// to replace "en" with "zh-Hans".
|
||||||
i18n: {
|
i18n: {
|
||||||
defaultLocale: 'en',
|
defaultLocale: "en",
|
||||||
locales: ['en'],
|
locales: ["en"],
|
||||||
},
|
},
|
||||||
|
|
||||||
// Plugins we added
|
// Plugins we added
|
||||||
// Only for react live
|
// Only for react live
|
||||||
themes: ['@docusaurus/theme-live-codeblock'],
|
themes: ["@docusaurus/theme-live-codeblock"],
|
||||||
|
|
||||||
// The classic preset will relay each option entry to the respective sub plugin/theme.
|
// The classic preset will relay each option entry to the respective sub plugin/theme.
|
||||||
presets: [
|
presets: [
|
||||||
[
|
[
|
||||||
'classic',
|
"classic",
|
||||||
/** @type {import('@docusaurus/preset-classic').Options} */
|
/** @type {import('@docusaurus/preset-classic').Options} */
|
||||||
({
|
({
|
||||||
// Will be passed to @docusaurus/plugin-content-docs (false to disable)
|
// Will be passed to @docusaurus/plugin-content-docs (false to disable)
|
||||||
docs: {
|
docs: {
|
||||||
routeBasePath: '/',
|
routeBasePath: "/",
|
||||||
sidebarPath: require.resolve('./sidebars.js'),
|
sidebarPath: require.resolve("./sidebars.js"),
|
||||||
editUrl:
|
editUrl: "https://github.com/janhq/jan/tree/main/docs",
|
||||||
'https://github.com/janhq/jan/tree/main/docs',
|
|
||||||
showLastUpdateAuthor: true,
|
showLastUpdateAuthor: true,
|
||||||
showLastUpdateTime: true,
|
showLastUpdateTime: true,
|
||||||
},
|
},
|
||||||
// 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: 'daily',
|
changefreq: "daily",
|
||||||
priority: 1.0,
|
priority: 1.0,
|
||||||
ignorePatterns: ['/tags/**'],
|
ignorePatterns: ["/tags/**"],
|
||||||
filename: 'sitemap.xml',
|
filename: "sitemap.xml",
|
||||||
},
|
},
|
||||||
// Will be passed to @docusaurus/plugin-content-blog (false to disable)
|
// Will be passed to @docusaurus/plugin-content-blog (false to disable)
|
||||||
blog: false,
|
blog: false,
|
||||||
// Will be passed to @docusaurus/theme-classic.
|
// Will be passed to @docusaurus/theme-classic.
|
||||||
theme: {
|
theme: {
|
||||||
customCss: require.resolve('./src/css/custom.css'),
|
customCss: require.resolve("./src/css/custom.css"),
|
||||||
},
|
},
|
||||||
// Will be passed to @docusaurus/plugin-content-pages (false to disable)
|
// Will be passed to @docusaurus/plugin-content-pages (false to disable)
|
||||||
// pages: {},
|
// pages: {},
|
||||||
@ -70,138 +69,138 @@ const config = {
|
|||||||
],
|
],
|
||||||
// Redoc preset
|
// Redoc preset
|
||||||
[
|
[
|
||||||
'redocusaurus',
|
"redocusaurus",
|
||||||
{
|
{
|
||||||
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: '/api/',
|
route: "/api/",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
theme: {
|
theme: {
|
||||||
primaryColor: '#1a73e8',
|
primaryColor: "#1a73e8",
|
||||||
primaryColorDark: '#1a73e8',
|
primaryColorDark: "#1a73e8",
|
||||||
// redocOptions: { hideDownloadButton: false },
|
// redocOptions: { hideDownloadButton: false },
|
||||||
},
|
},
|
||||||
}
|
},
|
||||||
]
|
],
|
||||||
],
|
],
|
||||||
|
|
||||||
// Docs: https://docusaurus.io/docs/api/themes/configuration
|
// Docs: https://docusaurus.io/docs/api/themes/configuration
|
||||||
themeConfig:
|
themeConfig:
|
||||||
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
||||||
({
|
({
|
||||||
image: 'img/jan-social-card.png',
|
image: "img/jan-social-card.png",
|
||||||
// Only for react live
|
// Only for react live
|
||||||
liveCodeBlock: {
|
liveCodeBlock: {
|
||||||
playgroundPosition: 'bottom',
|
playgroundPosition: "bottom",
|
||||||
},
|
},
|
||||||
navbar: {
|
navbar: {
|
||||||
title: 'Jan',
|
title: "Jan",
|
||||||
logo: {
|
logo: {
|
||||||
alt: 'Jan Logo',
|
alt: "Jan Logo",
|
||||||
src: 'img/logo.svg',
|
src: "img/logo.svg",
|
||||||
},
|
},
|
||||||
items: [
|
items: [
|
||||||
// Navbar Top
|
// Navbar Top
|
||||||
{
|
{
|
||||||
type: 'docSidebar',
|
type: "docSidebar",
|
||||||
sidebarId: 'featuresSidebar',
|
sidebarId: "featuresSidebar",
|
||||||
position: 'left',
|
position: "left",
|
||||||
label: 'Platform',
|
label: "Platform",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
type: 'docSidebar',
|
type: "docSidebar",
|
||||||
sidebarId: 'solutionsSidebar',
|
sidebarId: "solutionsSidebar",
|
||||||
position: 'left',
|
position: "left",
|
||||||
label: 'Use Cases',
|
label: "Use Cases",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
type: 'docSidebar',
|
type: "docSidebar",
|
||||||
sidebarId: 'docsSidebar',
|
sidebarId: "docsSidebar",
|
||||||
position: 'left',
|
position: "left",
|
||||||
label: 'Docs',
|
label: "Docs",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
type: 'docSidebar',
|
type: "docSidebar",
|
||||||
sidebarId: 'hardwareSidebar',
|
sidebarId: "hardwareSidebar",
|
||||||
position: 'left',
|
position: "left",
|
||||||
label: 'Hardware',
|
label: "Hardware",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
position: 'left',
|
position: "left",
|
||||||
label: 'API',
|
label: "API",
|
||||||
to: '/api',
|
to: "/api",
|
||||||
},
|
},
|
||||||
// Navbar right
|
// Navbar right
|
||||||
{
|
{
|
||||||
type: 'docSidebar',
|
type: "docSidebar",
|
||||||
sidebarId: 'aboutSidebar',
|
sidebarId: "aboutSidebar",
|
||||||
position: 'right',
|
position: "right",
|
||||||
label: 'About',
|
label: "About",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
href: 'https://github.com/janhq/jan',
|
href: "https://github.com/janhq/jan",
|
||||||
label: 'GitHub',
|
label: "GitHub",
|
||||||
position: 'right',
|
position: "right",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
footer: {
|
footer: {
|
||||||
style: 'dark',
|
style: "dark",
|
||||||
links: [
|
links: [
|
||||||
{
|
{
|
||||||
title: 'Documentation',
|
title: "Documentation",
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
label: 'Getting Started',
|
label: "Getting Started",
|
||||||
to: '/',
|
to: "/",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'Guides',
|
label: "Guides",
|
||||||
to: '/guides',
|
to: "/guides",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'Developer',
|
label: "Developer",
|
||||||
to: '/developer',
|
to: "/developer",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'API',
|
label: "API",
|
||||||
to: '/api',
|
to: "/api",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'Changelog',
|
label: "Changelog",
|
||||||
to: '/changelog',
|
to: "/changelog",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: 'Community',
|
title: "Community",
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
label: 'Discord',
|
label: "Discord",
|
||||||
href: 'https://discord.gg/FTk2MvZwJH',
|
href: "https://discord.gg/FTk2MvZwJH",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'Twitter',
|
label: "Twitter",
|
||||||
href: 'https://twitter.com/jan_dotai',
|
href: "https://twitter.com/jan_dotai",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: 'More',
|
title: "About",
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
label: 'About',
|
label: "About",
|
||||||
to: '/about',
|
to: "/about",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'Blog',
|
label: "Careers",
|
||||||
href: 'https://blog.jan.ai',
|
href: "https://janai.bamboohr.com/careers",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'GitHub',
|
label: "GitHub",
|
||||||
href: 'https://github.com/janhq/jan',
|
href: "https://github.com/janhq/jan",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
@ -211,7 +210,7 @@ const config = {
|
|||||||
prism: {
|
prism: {
|
||||||
theme: lightCodeTheme,
|
theme: lightCodeTheme,
|
||||||
darkTheme: darkCodeTheme,
|
darkTheme: darkCodeTheme,
|
||||||
additionalLanguages: ['python'],
|
additionalLanguages: ["python"],
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
};
|
};
|
||||||
|
|||||||
@ -14,7 +14,6 @@
|
|||||||
/** @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
|
||||||
aboutSidebar: [{ type: "autogenerated", dirName: "about" }],
|
|
||||||
|
|
||||||
// But you can create a sidebar manually
|
// But you can create a sidebar manually
|
||||||
featuresSidebar: [
|
featuresSidebar: [
|
||||||
@ -189,6 +188,32 @@ const sidebars = {
|
|||||||
],
|
],
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
aboutSidebar: [
|
||||||
|
{
|
||||||
|
type: "category",
|
||||||
|
label: "About Jan",
|
||||||
|
collapsible: true,
|
||||||
|
collapsed: false,
|
||||||
|
link: { type: "doc", id: "about/about" },
|
||||||
|
items: [
|
||||||
|
"about/roadmap",
|
||||||
|
{
|
||||||
|
type: "link",
|
||||||
|
label: "Careers",
|
||||||
|
href: "https://janai.bamboohr.com/careers",
|
||||||
|
},
|
||||||
|
"about/brand-assets",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: "category",
|
||||||
|
label: "Company Handbook",
|
||||||
|
collapsible: true,
|
||||||
|
collapsed: false,
|
||||||
|
link: { type: "doc", id: "handbook/handbook" },
|
||||||
|
items: ["handbook/remote-work"],
|
||||||
|
},
|
||||||
|
],
|
||||||
};
|
};
|
||||||
|
|
||||||
module.exports = sidebars;
|
module.exports = sidebars;
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user