feat(docs): add quick setup guide with layout update

Signed-off-by: Praveen Yadav <pyadav9678@gmail.com>
missingstudio · Mar 1, 2024 · 2643655 · 2643655
1 parent d3fc6cd
commit 2643655
Show file tree

Hide file tree

Showing 28 changed files with 704 additions and 438 deletions.
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,3 +1,5 @@
+version: '3.8'
+
 services:
   gateway:
     container_name: gateway
@@ -14,8 +16,6 @@ services:
       - GATEWAY_APP_PORT=8080
       - GATEWAY_REDIS_HOST=redis
       - GATEWAY_REDIS_PORT=6379
-      - GATEWAY_POSTGRES_DRIVER
-      - GATEWAY_POSTGRES_postgres=postgres
       - GATEWAY_POSTGRES_URL=postgres://mstudio@postgres:5432/mstudio?sslmode=disable
     ports:
       - 8080:8080

diff --git a/docs/api-reference/introduction.mdx b/docs/api-reference/introduction.mdx
@@ -0,0 +1,21 @@
+---
+title: "Introduction"
+description: "OpenAPI specification for API Endpoints"
+---
+
+<CardGroup cols={2}>
+  <Card title="API Keys" icon="key" href="/introduction/quickstart"></Card>
+</CardGroup>
+
+## Authentication
+
+All API endpoints are authenticated using `X-Ms-Api-Key` Header.
+
+```json
+X-Ms-Api-Key: <api-key>
+```
+
+<Info>
+  Store the provided API key securely; it will be required to pass the generated
+  and a valid API Key in Authorization header for subsequent API calls.
+</Info>
diff --git a/docs/connections/introduction.mdx b/docs/connections/introduction.mdx
@@ -0,0 +1,17 @@
+---
+title: "Introduction"
+description: "Ingest data to your existing Observablity Platform"
+---
+
+AI studio enhances observability by seamlessly exporting processed LLM data to your observability platform. This assists developers in bringing together all application-related data, including LLM usage metrics, on a unified platform, simplifying the visualization and assessment of the entire application ecosystem.
+
+---
+
+<CardGroup cols={2}>
+  <Card title="Providers" href="/providers/introduction" icon="circle-nodes">
+    Integrate your LLM Provider
+  </Card>
+  <Card title="API Refernce" href="/api-reference/introduction" icon="code">
+    OpenAPI specification for API Endpoints
+  </Card>
+</CardGroup>
diff --git a/docs/development/development.mdx b/docs/development/development.mdx
diff --git a/docs/development/quickstart.mdx b/docs/development/quickstart.mdx
diff --git a/docs/essentials/FAQ.mdx b/docs/essentials/FAQ.mdx
@@ -3,15 +3,16 @@ title: FAQ
 description: Get answers to the most frequently asked questions about missing studio
 icon: "question"
 ---
-Discover answers to the most frequently asked questions about missing studio. If your question isn't covered here, feel free to connect with our team on [Discord](https://discord.gg/dg8TYYqK) or [GitHub](https://github.com/missingstudio/studio).
+
+Discover answers to the most frequently asked questions about missing studio. If your question isn't covered here, feel free to connect with our team on [Discord Community.](https://discord.gg/99UVa6MkUX) or [GitHub](https://github.com/missingstudio/studio).
 
 ## Local contribution issues
 
 <AccordionGroup>
 
 <Accordion title="I'm experiencing issues setting up Missing studio locally!">
-  For troubleshooting, refer to our [setup guide](/introduction/setup). If your
-  issue persists, you're welcome to submit an [issue on
+  For troubleshooting, refer to our [setup guide](/introduction/quickstart). If
+  your issue persists, you're welcome to submit an [issue on
   GitHub](https://github.com/missingstudio/studio/issues).
 </Accordion>
 

diff --git a/docs/essentials/roadmap.mdx b/docs/essentials/roadmap.mdx
@@ -4,24 +4,31 @@ description: "See whats coming to missing studio in the future"
 icon: "road"
 ---
 
-Missing studio is currently in beta, and we're excited to share what we have in store! 
-This roadmap provides an overview of the features we're currently working on, as well as 
+Missing studio is currently in beta, and we're excited to share what we have in store!
+This roadmap provides an overview of the features we're currently working on, as well as
 the ones we've already completed.
 
-
 ## Planned Features
 
-<CardGroup cols={1}>
-  <Card title="Universal API">
-    Familiar with spending hundreds of hours with multiple providers to get things right. 
-    Try our universal API for seamless integration with 100+ providers like OpenAI, Anthropic, 
-    Cohere, and more.
+<CardGroup cols={2}>
+  <Card title="Universal API" icon="wand-magic-sparkles" color="#FFC414">
+    Familiar with spending hundreds of hours with multiple providers to get
+    things right. Try our universal API for seamless integration with 100+
+    providers like OpenAI, Anthropic, Cohere, and more.
+  </Card>
+  <Card title="AI Router" icon="scale-balanced" color="#00CCB1">
+    AI Router offers the versatility to route between multiple models or
+    provider using multiple fallback strategies like round-robin, least latency
+    etc.
   </Card>
-  <Card title="AI Router">
-    AI Router offers the versatility to route between multiple models or provider using multiple fallback strategies like round-robin, least latency etc.
+  <Card title="AI Gateway" icon="bolt" color="#18A0FB">
+    AI gateway allow us to gain visibility and control over AI Applications
+    using rate-limiting, retry, caching and observability.
   </Card>
-  <Card title="AI Gateway">
-    AI gateway allow us to gain visibility and control over AI Applications using rate-limiting, retry, caching and observability.
+  <Card title="Observability" icon="bolt" color="#FFC414">
+    Missing studio provides realtime visibility on **LLM usage, performance and
+    costs** without any vendor lock-in. It seamlessly connect with observability
+    platforms like Grafana to export your data
   </Card>
 </CardGroup>
 
@@ -30,7 +37,7 @@ the ones we've already completed.
 <Card>
   We continually update our roadmap and add new features, so stay tuned for
   updates! Feel free to check out our GitHub for the latest. As a small team, we
-  greatly appreciate the community's support in developing Missing studio. If you're
-  interested in contributing, please visit our [contributing
+  greatly appreciate the community's support in developing Missing studio. If
+  you're interested in contributing, please visit our [contributing
   page](/essentials/contributing).
 </Card>
diff --git a/docs/essentials/usecases.mdx b/docs/essentials/usecases.mdx
@@ -7,17 +7,16 @@ icon: "lightbulb"
 The versatile and dynamic nature of missing studio allows it to be applied in a plethora of scenarios. This page will introduce you to the different use cases of Missing studio and illustrate how it can be a game-changing tool in various fields.
 
 <Info>
-  The potential use cases for missing studio are almost limitless. From education to
-  healthcare, business to entertainment, missing studio can bring a new level of
-  efficiency and automation.
+  The potential use cases for missing studio are almost limitless. From
+  education to healthcare, business to entertainment, missing studio can bring a
+  new level of efficiency and automation.
 </Info>
 
-
 <CardGroup cols={2}>
   <Card
     title="Contribute on Discord"
     icon="discord"
-    href="https://discord.gg/dg8TYYqK"
+    href="https://discord.gg/99UVa6MkUX"
   >
     If you have an interesting use case in mind, or if you'd like to contribute
     to the development of these features, we'd love to hear from you! Reach out