wip(documentation): Work on mintlify docs

Signed-off-by: Diwank Singh Tomer <[email protected]>
julep-ai · Dec 24, 2024 · 6e1d59a · 6e1d59a
1 parent f9ebbf3
commit 6e1d59a
Show file tree

Hide file tree

Showing 70 changed files with 8,560 additions and 1,603 deletions.
diff --git a/agents-api/agents_api/activities/utils.py b/agents-api/agents_api/activities/utils.py
@@ -305,7 +305,6 @@ def get_handler(system: SystemDef) -> Callable:
     from ..models.docs.list_docs import list_docs as list_docs_query
     from ..models.entry.get_history import get_history as get_history_query
     from ..models.session.create_session import create_session as create_session_query
-    from ..models.session.delete_session import delete_session as delete_session_query
     from ..models.session.get_session import get_session as get_session_query
     from ..models.session.list_sessions import list_sessions as list_sessions_query
     from ..models.session.update_session import update_session as update_session_query

diff --git a/agents-api/agents_api/metrics/counters.py b/agents-api/agents_api/metrics/counters.py
@@ -34,17 +34,17 @@
     INF,
 )
 counter = Counter(
-    f"db_query_counter",
-    f"Number of db calls",
+    "db_query_counter",
+    "Number of db calls",
     labelnames=labelnames,
 )
 summary = Summary(
-    f"db_query_latency_summary",
+    "db_query_latency_summary",
     "Database query latency summary",
     labelnames=labelnames,
 )
 hist = Histogram(
-    f"db_query_latency_hist",
+    "db_query_latency_hist",
     "Database query latency histogram",
     labelnames=labelnames,
     buckets=buckets,

diff --git a/agents-api/agents_api/routers/healthz/check_health.py b/agents-api/agents_api/routers/healthz/check_health.py
@@ -1,7 +1,6 @@
 import logging
 from uuid import UUID
 
-from ...autogen.openapi_model import Agent, ListResponse
 from ...models.agent.list_agents import list_agents as list_agents_query
 from .router import router
 
@@ -10,7 +9,7 @@
 async def check_health() -> dict:
     try:
         # Check if the database is reachable
-        agents = list_agents_query(
+        list_agents_query(
             developer_id=UUID("00000000-0000-0000-0000-000000000000"),
         )
     except Exception as e:

diff --git a/documentation/README.md b/documentation/README.md
@@ -1,14 +1,6 @@
-# Mintlify Starter Kit
+# Julep Mintlify Documentation
 
-Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
-
-- Guide pages
-- Navigation
-- Customizations
-- API Reference pages
-- Use of popular components
-
-### Development
+## Development
 
 Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
 
@@ -22,11 +14,7 @@ Run the following command at the root of your documentation (where mint.json is)
 mintlify dev
 ```
 
-### Publishing Changes
-
-Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. 
-
-#### Troubleshooting
+### Troubleshooting
 
 - Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
 - Page loads as a 404 - Make sure you are running in a folder with `mint.json`
diff --git a/documentation/api-reference/endpoint/create.mdx b/documentation/api-reference/endpoint/create.mdx
diff --git a/documentation/api-reference/endpoint/delete.mdx b/documentation/api-reference/endpoint/delete.mdx
diff --git a/documentation/api-reference/endpoint/get.mdx b/documentation/api-reference/endpoint/get.mdx
diff --git a/documentation/api-reference/introduction.mdx b/documentation/api-reference/introduction.mdx
@@ -1,33 +1,51 @@
 ---
-title: 'Introduction'
-description: 'Example section for showcasing API endpoints'
+title: Introduction
+description: 'Introduction to the Julep REST API'
 ---
 
-<Note>
-  If you're not looking to build API reference documentation, you can delete
-  this section by removing the api-reference folder.
-</Note>
+<CardGroup cols={2}>
+  <Card
+    title="Agent Endpoints"
+    icon="robot"
+    href="/api-reference/agents/create"
+  >
+    Create, update, and manage AI agents
+  </Card>
+  <Card
+    title="Task Endpoints"
+    icon="list-check"
+    href="/api-reference/tasks/create"
+  >
+    Create and execute AI tasks and workflows
+  </Card>
+  <Card
+    title="Session Endpoints"
+    icon="comments"
+    href="/api-reference/sessions/create"
+  >
+    Manage conversation sessions and state
+  </Card>
+  <Card
+    title="Tool Endpoints"
+    icon="plug"
+    href="/api-reference/tools/register"
+  >
+    Register and manage agent tools
+  </Card>
+</CardGroup>
 
-## Welcome
+## Authentication
 
-There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification.
+<Note>
+  Authentication is done via API keys.
+</Note>
 
-<Card
-  title="Plant Store Endpoints"
-  icon="leaf"
-  href="https://github.com/mintlify/starter/blob/main/api-reference/openapi.json"
->
-  View the OpenAPI specification file
-</Card>
+API keys are used to authenticate requests to the Julep API. They can be created in the [Julep dashboard](https://dashboard.julep.ai).
 
-## Authentication
+To create an API key, go to the Julep dashboard and navigate to the "API Keys" section.
 
-All API endpoints are authenticated using Bearer tokens and picked up from the specification file.
+To use an API key, include it in the `Authorization` header of your request.
 
-```json
-"security": [
-  {
-    "bearerAuth": []
-  }
-]
+```
+Authorization: Bearer YOUR_API_KEY
 ```
diff --git a/documentation/api-reference/openapi.json b/documentation/api-reference/openapi.json