From 2e636d8fd6539bca19b7f7dbb95745a8cbcd3b44 Mon Sep 17 00:00:00 2001 From: 0xSage Date: Thu, 24 Aug 2023 16:44:30 +0800 Subject: [PATCH] docs: add company page --- docs/docs/changelog/README.md | 2 +- docs/docs/company/README.md | 6 +++ docs/docs/developer/README.md | 2 +- .../{quickstart => getting-started}/README.md | 2 +- docs/docs/guides/README.md | 2 +- docs/docs/reference/README.md | 2 +- docs/docusaurus.config.js | 46 ++++++++++++++----- docs/sidebars.js | 3 +- 8 files changed, 47 insertions(+), 18 deletions(-) create mode 100644 docs/docs/company/README.md rename docs/docs/{quickstart => getting-started}/README.md (71%) diff --git a/docs/docs/changelog/README.md b/docs/docs/changelog/README.md index d43bcf1d3..63249747b 100644 --- a/docs/docs/changelog/README.md +++ b/docs/docs/changelog/README.md @@ -2,5 +2,5 @@ sidebar_position: 1 --- -# Overview +# Changelog TODO \ No newline at end of file diff --git a/docs/docs/company/README.md b/docs/docs/company/README.md new file mode 100644 index 000000000..2124bab0a --- /dev/null +++ b/docs/docs/company/README.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 1 +--- + +# Company Handbook +TODO \ No newline at end of file diff --git a/docs/docs/developer/README.md b/docs/docs/developer/README.md index d43bcf1d3..56b4e330a 100644 --- a/docs/docs/developer/README.md +++ b/docs/docs/developer/README.md @@ -2,5 +2,5 @@ sidebar_position: 1 --- -# Overview +# Developer TODO \ No newline at end of file diff --git a/docs/docs/quickstart/README.md b/docs/docs/getting-started/README.md similarity index 71% rename from docs/docs/quickstart/README.md rename to docs/docs/getting-started/README.md index 170cb9976..4a94df25e 100644 --- a/docs/docs/quickstart/README.md +++ b/docs/docs/getting-started/README.md @@ -3,5 +3,5 @@ sidebar_position: 1 slug: / --- -# Welcome +# Getting Started Hi there \ No newline at end of file diff --git a/docs/docs/guides/README.md b/docs/docs/guides/README.md index d43bcf1d3..786bace1e 100644 --- a/docs/docs/guides/README.md +++ b/docs/docs/guides/README.md @@ -2,5 +2,5 @@ sidebar_position: 1 --- -# Overview +# Guides TODO \ No newline at end of file diff --git a/docs/docs/reference/README.md b/docs/docs/reference/README.md index d43bcf1d3..11400f9ee 100644 --- a/docs/docs/reference/README.md +++ b/docs/docs/reference/README.md @@ -2,5 +2,5 @@ sidebar_position: 1 --- -# Overview +# Reference TODO \ No newline at end of file diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 8261c0498..77afaf164 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -76,7 +76,7 @@ const config = { type: 'docSidebar', sidebarId: 'quickstartSidebar', position: 'left', - label: 'Quickstart', + label: 'Getting Started', }, { type: 'docSidebar', @@ -102,6 +102,12 @@ const config = { position: 'left', label: 'Changelog', }, + { + type: 'docSidebar', + sidebarId: 'companySidebar', + position: 'right', + label: 'Company', + }, // Navbar right { href: 'https://github.com/janhq/jan/docs', @@ -114,41 +120,57 @@ const config = { style: 'dark', links: [ { - title: 'Quickstart', + title: 'Documentation', items: [ { - label: 'Quickstart', - to: '/quickstart/overview', + label: 'Getting Started', + to: '/', + }, + { + label: 'Guides', + to: '/guides', + }, + { + label: 'Developer', + to: '/developer', + }, + { + label: 'Reference', + to: '/reference', + }, + { + label: 'Changelog', + to: '/changelog', }, ], }, { title: 'Community', items: [ - { - label: 'Stack Overflow', - href: 'https://stackoverflow.com/questions/tagged/docusaurus', - }, { label: 'Discord', - href: 'https://discordapp.com/invite/docusaurus', + href: 'https://discord.gg/FTk2MvZwJH', }, { label: 'Twitter', - href: 'https://twitter.com/docusaurus', + href: 'https://twitter.com/askjanai', }, ], }, { title: 'More', items: [ + { + label: 'Company', + to: '/company', + }, { label: 'Blog', - to: '/blog', + href: 'https://blog.jan.ai', }, { label: 'GitHub', - href: 'https://github.com/facebook/docusaurus', + href: 'https://github.com/janhq/jan', }, ], }, diff --git a/docs/sidebars.js b/docs/sidebars.js index 64c79e72e..22b4bd6be 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -15,12 +15,13 @@ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure quickstartSidebar: [{ - type: 'autogenerated', dirName: 'quickstart', + type: 'autogenerated', dirName: 'getting-started', }], guidesSidebar: [{ type: 'autogenerated', dirName: 'guides' }], developerSidebar: [{ type: 'autogenerated', dirName: 'developer' }], referenceSidebar: [{ type: 'autogenerated', dirName: 'reference' }], changelogSidebar: [{ type: 'autogenerated', dirName: 'changelog' }], + companySidebar: [{ type: 'autogenerated', dirName: 'company' }], // But you can create a sidebar manually /*