From a5f986f145caff1711fe459e02814aeefeb1c7f2 Mon Sep 17 00:00:00 2001
From: Amith Koujalgi <koujalgi.amith@gmail.com>
Date: Tue, 26 Dec 2023 16:13:36 +0530
Subject: [PATCH] Updated docs

---
 docs/docs/apis-ask/_category_.json            |  8 +++
 docs/docs/apis-ask/create-model.md            | 34 +++++++++++
 docs/docs/apis-ask/delete-model.md            | 31 ++++++++++
 docs/docs/apis-ask/generate-embeddings.md     | 57 +++++++++++++++++++
 docs/docs/apis-ask/get-model-details.md       | 57 +++++++++++++++++++
 docs/docs/apis-ask/list-models.md             | 43 ++++++++++++++
 docs/docs/apis-ask/pull-model.md              | 23 ++++++++
 .../apis-model-management/_category_.json     |  8 +++
 .../apis-model-management/create-model.md     | 34 +++++++++++
 .../apis-model-management/delete-model.md     | 31 ++++++++++
 .../generate-embeddings.md                    | 57 +++++++++++++++++++
 .../get-model-details.md                      | 57 +++++++++++++++++++
 .../docs/apis-model-management/list-models.md | 43 ++++++++++++++
 docs/docs/apis-model-management/pull-model.md | 23 ++++++++
 docs/docusaurus.config.js                     |  2 +-
 15 files changed, 507 insertions(+), 1 deletion(-)
 create mode 100644 docs/docs/apis-ask/_category_.json
 create mode 100644 docs/docs/apis-ask/create-model.md
 create mode 100644 docs/docs/apis-ask/delete-model.md
 create mode 100644 docs/docs/apis-ask/generate-embeddings.md
 create mode 100644 docs/docs/apis-ask/get-model-details.md
 create mode 100644 docs/docs/apis-ask/list-models.md
 create mode 100644 docs/docs/apis-ask/pull-model.md
 create mode 100644 docs/docs/apis-model-management/_category_.json
 create mode 100644 docs/docs/apis-model-management/create-model.md
 create mode 100644 docs/docs/apis-model-management/delete-model.md
 create mode 100644 docs/docs/apis-model-management/generate-embeddings.md
 create mode 100644 docs/docs/apis-model-management/get-model-details.md
 create mode 100644 docs/docs/apis-model-management/list-models.md
 create mode 100644 docs/docs/apis-model-management/pull-model.md

diff --git a/docs/docs/apis-ask/_category_.json b/docs/docs/apis-ask/_category_.json
new file mode 100644
index 0000000..edd59f0
--- /dev/null
+++ b/docs/docs/apis-ask/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "APIs - Ask",
+  "position": 10,
+  "link": {
+    "type": "generated-index",
+    "description": "Specs of APIs and their usage."
+  }
+}
diff --git a/docs/docs/apis-ask/create-model.md b/docs/docs/apis-ask/create-model.md
new file mode 100644
index 0000000..0b51b4e
--- /dev/null
+++ b/docs/docs/apis-ask/create-model.md
@@ -0,0 +1,34 @@
+---
+sidebar_position: 3
+---
+
+# Create Model
+
+Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
+
+## Create your first Post
+
+Create a file at `blog/2021-02-28-greetings.md`:
+
+```md title="blog/2021-02-28-greetings.md"
+---
+slug: greetings
+title: Greetings!
+authors:
+  - name: Joel Marcey
+    title: Co-creator of Docusaurus 1
+    url: https://github.com/JoelMarcey
+    image_url: https://github.com/JoelMarcey.png
+  - name: Sébastien Lorber
+    title: Docusaurus maintainer
+    url: https://sebastienlorber.com
+    image_url: https://github.com/slorber.png
+tags: [greetings]
+---
+
+Congratulations, you have made your first post!
+
+Feel free to play around and edit this post as much you like.
+```
+
+A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
diff --git a/docs/docs/apis-ask/delete-model.md b/docs/docs/apis-ask/delete-model.md
new file mode 100644
index 0000000..ec765b8
--- /dev/null
+++ b/docs/docs/apis-ask/delete-model.md
@@ -0,0 +1,31 @@
+---
+sidebar_position: 5
+---
+
+# Delete Model
+
+Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
+
+It builds your site as simple **static HTML, JavaScript and CSS files**.
+
+## Build your site
+
+Build your site **for production**:
+
+```bash
+npm run build
+```
+
+The static files are generated in the `build` folder.
+
+## Deploy your site
+
+Test your production build locally:
+
+```bash
+npm run serve
+```
+
+The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
+
+You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
diff --git a/docs/docs/apis-ask/generate-embeddings.md b/docs/docs/apis-ask/generate-embeddings.md
new file mode 100644
index 0000000..69cb125
--- /dev/null
+++ b/docs/docs/apis-ask/generate-embeddings.md
@@ -0,0 +1,57 @@
+---
+sidebar_position: 2
+---
+
+# Generate Embeddings
+
+Documents are **groups of pages** connected through:
+
+- a **sidebar**
+- **previous/next navigation**
+- **versioning**
+
+## Create your first Doc
+
+Create a Markdown file at `docs/hello.md`:
+
+```md title="docs/hello.md"
+# Hello
+
+This is my **first Docusaurus document**!
+```
+
+A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
+
+## Configure the Sidebar
+
+Docusaurus automatically **creates a sidebar** from the `docs` folder.
+
+Add metadata to customize the sidebar label and position:
+
+```md title="docs/hello.md" {1-4}
+---
+sidebar_label: 'Hi!'
+sidebar_position: 3
+---
+
+# Hello
+
+This is my **first Docusaurus document**!
+```
+
+It is also possible to create your sidebar explicitly in `sidebars.js`:
+
+```js title="sidebars.js"
+export default {
+  tutorialSidebar: [
+    'intro',
+    // highlight-next-line
+    'hello',
+    {
+      type: 'category',
+      label: 'Tutorial',
+      items: ['tutorial-basics/create-a-document'],
+    },
+  ],
+};
+```
diff --git a/docs/docs/apis-ask/get-model-details.md b/docs/docs/apis-ask/get-model-details.md
new file mode 100644
index 0000000..ce9f9a8
--- /dev/null
+++ b/docs/docs/apis-ask/get-model-details.md
@@ -0,0 +1,57 @@
+---
+sidebar_position: 2
+---
+
+# Get Model Details
+
+Documents are **groups of pages** connected through:
+
+- a **sidebar**
+- **previous/next navigation**
+- **versioning**
+
+## Create your first Doc
+
+Create a Markdown file at `docs/hello.md`:
+
+```md title="docs/hello.md"
+# Hello
+
+This is my **first Docusaurus document**!
+```
+
+A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
+
+## Configure the Sidebar
+
+Docusaurus automatically **creates a sidebar** from the `docs` folder.
+
+Add metadata to customize the sidebar label and position:
+
+```md title="docs/hello.md" {1-4}
+---
+sidebar_label: 'Hi!'
+sidebar_position: 3
+---
+
+# Hello
+
+This is my **first Docusaurus document**!
+```
+
+It is also possible to create your sidebar explicitly in `sidebars.js`:
+
+```js title="sidebars.js"
+export default {
+  tutorialSidebar: [
+    'intro',
+    // highlight-next-line
+    'hello',
+    {
+      type: 'category',
+      label: 'Tutorial',
+      items: ['tutorial-basics/create-a-document'],
+    },
+  ],
+};
+```
diff --git a/docs/docs/apis-ask/list-models.md b/docs/docs/apis-ask/list-models.md
new file mode 100644
index 0000000..f995906
--- /dev/null
+++ b/docs/docs/apis-ask/list-models.md
@@ -0,0 +1,43 @@
+---
+sidebar_position: 1
+---
+
+# List Models
+
+Add **Markdown or React** files to `src/pages` to create a **standalone page**:
+
+- `src/pages/index.js` → `localhost:3000/`
+- `src/pages/foo.md` → `localhost:3000/foo`
+- `src/pages/foo/bar.js` → `localhost:3000/foo/bar`
+
+## Create your first React Page
+
+Create a file at `src/pages/my-react-page.js`:
+
+```jsx title="src/pages/my-react-page.js"
+import React from 'react';
+import Layout from '@theme/Layout';
+
+export default function MyReactPage() {
+  return (
+    <Layout>
+      <h1>My React page</h1>
+      <p>This is a React page</p>
+    </Layout>
+  );
+}
+```
+
+A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).
+
+## Create your first Markdown Page
+
+Create a file at `src/pages/my-markdown-page.md`:
+
+```mdx title="src/pages/my-markdown-page.md"
+# My Markdown page
+
+This is a Markdown page
+```
+
+A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).
diff --git a/docs/docs/apis-ask/pull-model.md b/docs/docs/apis-ask/pull-model.md
new file mode 100644
index 0000000..3cad099
--- /dev/null
+++ b/docs/docs/apis-ask/pull-model.md
@@ -0,0 +1,23 @@
+---
+sidebar_position: 6
+---
+
+# Pull Model
+
+You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
+
+Docusaurus has **much more to offer**!
+
+Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
+
+Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
+
+## What's next?
+
+- Read the [official documentation](https://docusaurus.io/)
+- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config)
+- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration)
+- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
+- Add a [search bar](https://docusaurus.io/docs/search)
+- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
+- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
diff --git a/docs/docs/apis-model-management/_category_.json b/docs/docs/apis-model-management/_category_.json
new file mode 100644
index 0000000..fee7bea
--- /dev/null
+++ b/docs/docs/apis-model-management/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "APIs - Model Management",
+  "position": 4,
+  "link": {
+    "type": "generated-index",
+    "description": "Specs of APIs and their usage."
+  }
+}
diff --git a/docs/docs/apis-model-management/create-model.md b/docs/docs/apis-model-management/create-model.md
new file mode 100644
index 0000000..0b51b4e
--- /dev/null
+++ b/docs/docs/apis-model-management/create-model.md
@@ -0,0 +1,34 @@
+---
+sidebar_position: 3
+---
+
+# Create Model
+
+Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
+
+## Create your first Post
+
+Create a file at `blog/2021-02-28-greetings.md`:
+
+```md title="blog/2021-02-28-greetings.md"
+---
+slug: greetings
+title: Greetings!
+authors:
+  - name: Joel Marcey
+    title: Co-creator of Docusaurus 1
+    url: https://github.com/JoelMarcey
+    image_url: https://github.com/JoelMarcey.png
+  - name: Sébastien Lorber
+    title: Docusaurus maintainer
+    url: https://sebastienlorber.com
+    image_url: https://github.com/slorber.png
+tags: [greetings]
+---
+
+Congratulations, you have made your first post!
+
+Feel free to play around and edit this post as much you like.
+```
+
+A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
diff --git a/docs/docs/apis-model-management/delete-model.md b/docs/docs/apis-model-management/delete-model.md
new file mode 100644
index 0000000..ec765b8
--- /dev/null
+++ b/docs/docs/apis-model-management/delete-model.md
@@ -0,0 +1,31 @@
+---
+sidebar_position: 5
+---
+
+# Delete Model
+
+Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
+
+It builds your site as simple **static HTML, JavaScript and CSS files**.
+
+## Build your site
+
+Build your site **for production**:
+
+```bash
+npm run build
+```
+
+The static files are generated in the `build` folder.
+
+## Deploy your site
+
+Test your production build locally:
+
+```bash
+npm run serve
+```
+
+The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
+
+You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
diff --git a/docs/docs/apis-model-management/generate-embeddings.md b/docs/docs/apis-model-management/generate-embeddings.md
new file mode 100644
index 0000000..69cb125
--- /dev/null
+++ b/docs/docs/apis-model-management/generate-embeddings.md
@@ -0,0 +1,57 @@
+---
+sidebar_position: 2
+---
+
+# Generate Embeddings
+
+Documents are **groups of pages** connected through:
+
+- a **sidebar**
+- **previous/next navigation**
+- **versioning**
+
+## Create your first Doc
+
+Create a Markdown file at `docs/hello.md`:
+
+```md title="docs/hello.md"
+# Hello
+
+This is my **first Docusaurus document**!
+```
+
+A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
+
+## Configure the Sidebar
+
+Docusaurus automatically **creates a sidebar** from the `docs` folder.
+
+Add metadata to customize the sidebar label and position:
+
+```md title="docs/hello.md" {1-4}
+---
+sidebar_label: 'Hi!'
+sidebar_position: 3
+---
+
+# Hello
+
+This is my **first Docusaurus document**!
+```
+
+It is also possible to create your sidebar explicitly in `sidebars.js`:
+
+```js title="sidebars.js"
+export default {
+  tutorialSidebar: [
+    'intro',
+    // highlight-next-line
+    'hello',
+    {
+      type: 'category',
+      label: 'Tutorial',
+      items: ['tutorial-basics/create-a-document'],
+    },
+  ],
+};
+```
diff --git a/docs/docs/apis-model-management/get-model-details.md b/docs/docs/apis-model-management/get-model-details.md
new file mode 100644
index 0000000..ce9f9a8
--- /dev/null
+++ b/docs/docs/apis-model-management/get-model-details.md
@@ -0,0 +1,57 @@
+---
+sidebar_position: 2
+---
+
+# Get Model Details
+
+Documents are **groups of pages** connected through:
+
+- a **sidebar**
+- **previous/next navigation**
+- **versioning**
+
+## Create your first Doc
+
+Create a Markdown file at `docs/hello.md`:
+
+```md title="docs/hello.md"
+# Hello
+
+This is my **first Docusaurus document**!
+```
+
+A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
+
+## Configure the Sidebar
+
+Docusaurus automatically **creates a sidebar** from the `docs` folder.
+
+Add metadata to customize the sidebar label and position:
+
+```md title="docs/hello.md" {1-4}
+---
+sidebar_label: 'Hi!'
+sidebar_position: 3
+---
+
+# Hello
+
+This is my **first Docusaurus document**!
+```
+
+It is also possible to create your sidebar explicitly in `sidebars.js`:
+
+```js title="sidebars.js"
+export default {
+  tutorialSidebar: [
+    'intro',
+    // highlight-next-line
+    'hello',
+    {
+      type: 'category',
+      label: 'Tutorial',
+      items: ['tutorial-basics/create-a-document'],
+    },
+  ],
+};
+```
diff --git a/docs/docs/apis-model-management/list-models.md b/docs/docs/apis-model-management/list-models.md
new file mode 100644
index 0000000..f995906
--- /dev/null
+++ b/docs/docs/apis-model-management/list-models.md
@@ -0,0 +1,43 @@
+---
+sidebar_position: 1
+---
+
+# List Models
+
+Add **Markdown or React** files to `src/pages` to create a **standalone page**:
+
+- `src/pages/index.js` → `localhost:3000/`
+- `src/pages/foo.md` → `localhost:3000/foo`
+- `src/pages/foo/bar.js` → `localhost:3000/foo/bar`
+
+## Create your first React Page
+
+Create a file at `src/pages/my-react-page.js`:
+
+```jsx title="src/pages/my-react-page.js"
+import React from 'react';
+import Layout from '@theme/Layout';
+
+export default function MyReactPage() {
+  return (
+    <Layout>
+      <h1>My React page</h1>
+      <p>This is a React page</p>
+    </Layout>
+  );
+}
+```
+
+A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).
+
+## Create your first Markdown Page
+
+Create a file at `src/pages/my-markdown-page.md`:
+
+```mdx title="src/pages/my-markdown-page.md"
+# My Markdown page
+
+This is a Markdown page
+```
+
+A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).
diff --git a/docs/docs/apis-model-management/pull-model.md b/docs/docs/apis-model-management/pull-model.md
new file mode 100644
index 0000000..3cad099
--- /dev/null
+++ b/docs/docs/apis-model-management/pull-model.md
@@ -0,0 +1,23 @@
+---
+sidebar_position: 6
+---
+
+# Pull Model
+
+You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
+
+Docusaurus has **much more to offer**!
+
+Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
+
+Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
+
+## What's next?
+
+- Read the [official documentation](https://docusaurus.io/)
+- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config)
+- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration)
+- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
+- Add a [search bar](https://docusaurus.io/docs/search)
+- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
+- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
index 7147e33..6f7dc96 100644
--- a/docs/docusaurus.config.js
+++ b/docs/docusaurus.config.js
@@ -76,7 +76,7 @@ const config = {
             type: 'docSidebar',
             sidebarId: 'tutorialSidebar',
             position: 'left',
-            label: 'Tutorial',
+            label: 'Usage',
           },
           {to: '/blog', label: 'Blog', position: 'left'},
           {to: 'https://amithkoujalgi.github.io/ollama4j/apidocs/', label: 'Javadoc', position: 'left'},