update: docs framework is done, keep simple and clean

ServerlessLLM · Jul 1, 2024 · 3b62b75 · 3b62b75
1 parent dd5f59b
commit 3b62b75
Show file tree

Hide file tree

Showing 23 changed files with 30 additions and 144 deletions.
diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md
diff --git a/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md
diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx
diff --git a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/blog/2021-08-26-welcome/index.md b/blog/2021-08-26-welcome/index.md
diff --git a/blog/authors.yml b/blog/authors.yml
diff --git a/blog/tags.yml b/blog/tags.yml
diff --git a/docs/api/intro.md b/docs/api/intro.md
@@ -0,0 +1,5 @@
+---
+sidebar_position: 1
+---
+
+# API docs
diff --git a/docs/intro.md → docs/stable/intro.md b/docs/intro.md → docs/stable/intro.md
diff --git a/docs/tutorial-basics/_category_.json → docs/stable/tutorial-basics/_category_.json b/docs/tutorial-basics/_category_.json → docs/stable/tutorial-basics/_category_.json
diff --git a/docs/tutorial-basics/congratulations.md → ...stable/tutorial-basics/congratulations.md b/docs/tutorial-basics/congratulations.md → ...stable/tutorial-basics/congratulations.md
diff --git a/docs/tutorial-basics/create-a-blog-post.md → ...ble/tutorial-basics/create-a-blog-post.md b/docs/tutorial-basics/create-a-blog-post.md → ...ble/tutorial-basics/create-a-blog-post.md
diff --git a/docs/tutorial-basics/create-a-document.md → ...able/tutorial-basics/create-a-document.md b/docs/tutorial-basics/create-a-document.md → ...able/tutorial-basics/create-a-document.md
diff --git a/docs/tutorial-basics/create-a-page.md → docs/stable/tutorial-basics/create-a-page.md b/docs/tutorial-basics/create-a-page.md → docs/stable/tutorial-basics/create-a-page.md
diff --git a/docs/tutorial-basics/deploy-your-site.md → ...table/tutorial-basics/deploy-your-site.md b/docs/tutorial-basics/deploy-your-site.md → ...table/tutorial-basics/deploy-your-site.md
diff --git a/docs/tutorial-basics/markdown-features.mdx → ...ble/tutorial-basics/markdown-features.mdx b/docs/tutorial-basics/markdown-features.mdx → ...ble/tutorial-basics/markdown-features.mdx
diff --git a/docs/tutorial-extras/_category_.json → docs/stable/tutorial-extras/_category_.json b/docs/tutorial-extras/_category_.json → docs/stable/tutorial-extras/_category_.json
diff --git a/...torial-extras/img/docsVersionDropdown.png → ...torial-extras/img/docsVersionDropdown.png b/...torial-extras/img/docsVersionDropdown.png → ...torial-extras/img/docsVersionDropdown.png
diff --git a/docs/tutorial-extras/img/localeDropdown.png → ...le/tutorial-extras/img/localeDropdown.png b/docs/tutorial-extras/img/localeDropdown.png → ...le/tutorial-extras/img/localeDropdown.png
diff --git a/docs/tutorial-extras/manage-docs-versions.md → ...e/tutorial-extras/manage-docs-versions.md b/docs/tutorial-extras/manage-docs-versions.md → ...e/tutorial-extras/manage-docs-versions.md
diff --git a/docs/tutorial-extras/translate-your-site.md → ...le/tutorial-extras/translate-your-site.md b/docs/tutorial-extras/translate-your-site.md → ...le/tutorial-extras/translate-your-site.md
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -8,8 +8,8 @@ import {themes as prismThemes} from 'prism-react-renderer';
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
-  title: 'My Site',
-  tagline: 'Dinosaurs are cool',
+  title: 'ServerlessLLM',
+  tagline: 'Serverless + LLM = ❤️',
   favicon: 'img/favicon.ico',
 
   // Set the production url of your site here
@@ -66,7 +66,7 @@ const config = {
       // Replace with your project's social card
       image: 'img/docusaurus-social-card.jpg',
       navbar: {
-        title: 'My Site',
+        title: 'ServerlessLLM',
         logo: {
           alt: 'My Site Logo',
           src: 'img/logo.svg',
@@ -76,9 +76,14 @@ const config = {
             type: 'docSidebar',
             sidebarId: 'tutorialSidebar',
             position: 'left',
-            label: 'Tutorial',
+            label: 'Documents',
+          },
+          {
+            type: 'docSidebar',
+            sidebarId: 'apiSidebar',
+            position: 'left',
+            label: 'API',
           },
-          {to: '/blog', label: 'Blog', position: 'left'},
           {
             href: 'https://github.com/facebook/docusaurus',
             label: 'GitHub',
@@ -93,9 +98,13 @@ const config = {
             title: 'Docs',
             items: [
               {
-                label: 'Tutorial',
+                label: 'Documents',
                 to: '/docs/intro',
               },
+              {
+                label: 'API',
+                to: '/api'
+              }
             ],
           },
           {
@@ -119,8 +128,8 @@ const config = {
             title: 'More',
             items: [
               {
-                label: 'Blog',
-                to: '/blog',
+                label: 'API',
+                to: '/api',
               },
               {
                 label: 'GitHub',
@@ -129,7 +138,7 @@ const config = {
             ],
           },
         ],
-        copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
+        copyright: `Copyright © ${new Date().getFullYear()} ServerlessLLM, Inc. Built with Docusaurus.`,
       },
       prism: {
         theme: prismThemes.github,

diff --git a/sidebars.js b/sidebars.js
@@ -14,7 +14,13 @@
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
   // By default, Docusaurus generates a sidebar from the docs folder structure
-  tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
+  tutorialSidebar: [
+    {
+      type: 'autogenerated',
+      dirName: 'stable',
+    },
+  ],
+  apiSidebar: [{type: 'autogenerated', dirName: 'api'}],
 
   // But you can create a sidebar manually
   /*