diff --git a/README.md b/README.md index db074e12b..49b599762 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,9 @@ Run an entire AI stack locally, from the inference engine to a shareable web app Jan is free, source-available, and fair-code licensed. -> 👋 Access a live demo at https://cloud.jan.ai. +> 👋 Use a live demo at https://cloud.jan.ai. + +> 👾 Detailed developer docs at https://docs.jan.ai/. ## Intended use - Run ChatGPT and Midjourney alternatives on-prem and on your private data diff --git a/docs/docs/about/README.md b/docs/docs/about/README.md index 42956286a..e9e7d5ca9 100644 --- a/docs/docs/about/README.md +++ b/docs/docs/about/README.md @@ -1,4 +1,4 @@ --- sidebar_position: 1 -title: Overview +title: About Jan --- diff --git a/docs/docs/changelog/README.md b/docs/docs/changelog/README.md index 63249747b..9ba595391 100644 --- a/docs/docs/changelog/README.md +++ b/docs/docs/changelog/README.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 +title: Changelog --- -# Changelog TODO \ No newline at end of file diff --git a/docs/docs/getting-started/README.mdx b/docs/docs/getting-started/README.mdx index 326f50318..a2c259f35 100644 --- a/docs/docs/getting-started/README.mdx +++ b/docs/docs/getting-started/README.mdx @@ -1,9 +1,9 @@ --- sidebar_position: 1 +title: Getting Started slug: / --- -# Getting Started Hi there import Tabs from '@theme/Tabs'; diff --git a/docs/docs/glossary/README.md b/docs/docs/glossary/README.md new file mode 100644 index 000000000..fe6c79197 --- /dev/null +++ b/docs/docs/glossary/README.md @@ -0,0 +1,4 @@ +--- +sidebar_position: 1 +title: Glossary +--- diff --git a/docs/docs/guides/README.md b/docs/docs/guides/README.md index 786bace1e..f3132822a 100644 --- a/docs/docs/guides/README.md +++ b/docs/docs/guides/README.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 +title: Guides --- -# Guides TODO \ No newline at end of file diff --git a/docs/docs/integrations/README.md b/docs/docs/integrations/README.md new file mode 100644 index 000000000..dee6e6163 --- /dev/null +++ b/docs/docs/integrations/README.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 1 +title: Integrations +--- + +TODO \ No newline at end of file diff --git a/docs/docs/developer/README.md b/docs/docs/self-host/README.md similarity index 66% rename from docs/docs/developer/README.md rename to docs/docs/self-host/README.md index 56b4e330a..525c10143 100644 --- a/docs/docs/developer/README.md +++ b/docs/docs/self-host/README.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 +title: Self Host --- -# Developer TODO \ No newline at end of file diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 27c752455..aa9bfff84 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -119,21 +119,21 @@ const config = { }, { type: 'docSidebar', - sidebarId: 'developerSidebar', + sidebarId: 'selfhostSidebar', position: 'left', - label: 'Developer', + label: 'Self Host', + }, + { + type: 'docSidebar', + sidebarId: 'integrationsSidebar', + position: 'left', + label: 'Integrations', }, { position: 'left', label: 'Reference', to: '/reference', }, - { - type: 'docSidebar', - sidebarId: 'changelogSidebar', - position: 'left', - label: 'Changelog', - }, // Navbar right { type: 'docSidebar', diff --git a/docs/sidebars.js b/docs/sidebars.js index ee6570987..02d45e801 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -18,7 +18,9 @@ const sidebars = { type: 'autogenerated', dirName: 'getting-started', }], guidesSidebar: [{ type: 'autogenerated', dirName: 'guides' }], - developerSidebar: [{ type: 'autogenerated', dirName: 'developer' }], + selfhostSidebar: [{ type: 'autogenerated', dirName: 'self-host' }], + integrationsSidebar: [{ type: 'autogenerated', dirName: 'integrations' }], + glossarySidebar: [{ type: 'autogenerated', dirName: 'glossary' }], changelogSidebar: [{ type: 'autogenerated', dirName: 'changelog' }], aboutSidebar: [{ type: 'autogenerated', dirName: 'about' }], diff --git a/docs/static/img/logo.svg b/docs/static/img/logo.svg index cbc5b613c..e3875cf31 100644 --- a/docs/static/img/logo.svg +++ b/docs/static/img/logo.svg @@ -1 +1,12 @@ - \ No newline at end of file + + + + + + + + + + + +