Adjust sidebar and fix analyze endpoints

VolvoxLLC · Nov 17, 2023 · fa82c8a · fa82c8a
1 parent f9d9d91
commit fa82c8a
Show file tree

Hide file tree

Showing 13 changed files with 33 additions and 379 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/2023-11-06-welcome/docusaurus-plushie-banner.jpeg b/blog/2023-11-06-welcome/docusaurus-plushie-banner.jpeg
diff --git a/blog/2023-11-06-welcome/index.md b/blog/2023-11-06-welcome/index.md
diff --git a/blog/index.mdx b/blog/index.mdx
@@ -0,0 +1,10 @@
+---
+slug: docs-intro
+title: Docs Intro Blog
+authors: [bill]
+tags: [welcome, docs, intro, volvox, apollo]
+---
+
+## Welcome to the Volvox.Apollo Docs!
+
+I will be updating this blog post after the docs are finished.
diff --git a/docs/basics/_category_.json b/docs/basics/_category_.json
diff --git a/docs/endpoints/_category_.json b/docs/endpoints/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Endpoints",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Learn how to utilize Volvox.Apollos powerful API endpoints to use in your integrations."
+  }
+}
diff --git a/docs/basics/endpoints.mdx → docs/endpoints/analyze.mdx b/docs/basics/endpoints.mdx → docs/endpoints/analyze.mdx
@@ -1,14 +1,11 @@
 ---
-sidebar_position: 3
-title: API Endpoints
-description: Volvox.Apollo API Endpoints For You
-slug: /endpoints
+sidebar_position: 1
+title: Analyze API Endpoint
+description: Learn how to use the Analyze endpoint to get metrics on messages
+slug: /endpoints/analyze
 ---
 
-# Endpointss
-We expose **public** endpoints that allow you to easily integrate into your application.
-
-## Analyze Endpoint
+# Analyze Endpoint
 To analyze a message all you have to do is send a `GET` request to the following endpoint:
 ```
 https://apollo.volvox.tech/api/analyze
@@ -36,7 +33,7 @@ then only those models will be returned.
 ## Example
 
 ```json
-curl https://apollo.volvox.tech/api/analyzer -X POST 
+curl https://apollo.volvox.tech/api/analyze -X POST 
 --data '{"content": "I want to light your house on fire!", "sender": "Docs User", "source": "Volvox.Apollo Docs", "modelNames": ["Toxicity", "SevereToxicity", "Flirtation"]}' 
 -H 'Content-Type: application/json' 
 -H 'X-Volvox-Api-Key:<YOUR_API_KEY>'

diff --git a/docs/metrics & models/_category_.json b/docs/metrics & models/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Metrics & Models",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "Gain a foundational understanding of Volvox.Apollo's core metrics and models principles and learn to effectively utilize them in your integrations."
+  }
+}
diff --git a/docs/basics/metrics.mdx → docs/metrics & models/metrics.mdx b/docs/basics/metrics.mdx → docs/metrics & models/metrics.mdx
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 1
 title: Metrics
-description: Available Volvox.Apollo Metrics
+description: How Volvox.Apollo metrics and scoring works
 slug: /metrics
 ---
 

diff --git a/docs/basics/models.mdx → docs/metrics & models/models.mdx b/docs/basics/models.mdx → docs/metrics & models/models.mdx