jan/docs/sidebars.js
2023-11-22 11:01:26 +07:00

137 lines
3.0 KiB
JavaScript

/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars are explicitly defined here.
Create as many sidebars as you want.
*/
// @ts-check
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
docsSidebar: [
{
type: "category",
label: "Introduction",
link: { type: "doc", id: "intro/introduction" },
collapsible: true,
collapsed: true,
items: ["intro/quickstart", "intro/how-jan-works"],
},
{
type: "category",
label: "Installation",
collapsible: true,
collapsed: true,
items: ["install/windows", "install/mac", "install/linux"],
},
{
type: "category",
label: "Using Jan",
collapsible: true,
collapsed: true,
items: ["docs/models", "docs/server"],
},
{
type: "category",
label: "Extending Jan",
link: { type: "doc", id: "docs/extensions" },
collapsible: true,
collapsed: true,
items: ["docs/assistants", "docs/themes", "docs/tools", "docs/modules"],
},
{
type: "category",
label: "Building Jan",
collapsible: true,
collapsed: true,
items: [
"specs/architecture",
"specs/data-structures",
"specs/user-interface",
{
type: "category",
label: "Specifications",
collapsible: true,
collapsed: false,
items: [
"specs/chats",
"specs/models",
"specs/threads",
"specs/messages",
// "specs/assistants",
// "specs/files",
// "specs/jan",
// "specs/fine-tuning",
// "specs/settings",
// "specs/prompts",
],
},
],
},
],
apiSidebar: [
"api/overview",
{
type: "category",
label: "Endpoints",
collapsible: true,
collapsed: false,
items: [
{
type: "autogenerated",
dirName: "api",
},
],
},
],
aboutSidebar: [
{
type: "doc",
label: "About Jan",
id: "about/about",
},
{
type: "link",
label: "Careers",
href: "https://janai.bamboohr.com/careers",
},
{
type: "category",
label: "Events",
collapsible: true,
collapsed: true,
items: [
"events/nvidia-llm-day-nov-23",
{
type: "doc",
label: "Oct 23: HCMC Hacker House",
id: "events/hcmc-oct23",
},
],
},
{
type: "category",
label: "Company Handbook",
collapsible: true,
collapsed: true,
// link: { type: "doc", id: "handbook/handbook" },
items: [
{
type: "doc",
label: "Engineering",
id: "handbook/engineering/engineering",
},
],
},
],
};
module.exports = sidebars;