Skip to content

perf(wip): updating layout #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -8,23 +8,23 @@ Click on `Use this template` to copy the Mintlify starter kit. The starter kit c
- 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

```
```bash
npm i -g mintlify
```

Run the following command at the root of your documentation (where mint.json is)

```
```bash
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.
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

10 changes: 3 additions & 7 deletions api-reference/introduction.mdx
Original file line number Diff line number Diff line change
@@ -8,15 +8,11 @@ description: 'Example section for showcasing API endpoints'
this section by removing the api-reference folder.
</Note>

## Welcome
## Welcome!

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.

<Card
title="Plant Store Endpoints"
icon="leaf"
href="https://github.com/mintlify/starter/blob/main/api-reference/openapi.json"
>
<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>

@@ -30,4 +26,4 @@ All API endpoints are authenticated using Bearer tokens and picked up from the s
"bearerAuth": []
}
]
```
```
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Introduction
icon: font
description: "Welcome to Undrstnd Developers, the platform that provides lightning-fast, eco-friendly, and highly affordable AI solutions for developers"
---

4 changes: 4 additions & 0 deletions documentation/models.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Models
description: "..."
---
81 changes: 81 additions & 0 deletions documentation/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
title: Overview
icon: graduation-cap
---

## Undrstnd Developers platform

<Card
title="Developer quickstart"
icon="bolt"
>
<Icon icon="clock" size='12' /> 5 min

Set up your environment and make your first API request in minutes,
[go to quickstart](/documentation/quickstart).

<br />
<CodeGroup>
```java Curl
curl https://api.undrstnd-labs.com/v1/chat/completions
-H "Content-Type: application/json"
-H "Authorization: Bearer $UNDRSTND_API_KEY"
-d '{
"model": "llama3-8b-8192",
"messages": [
{"role": "user", "content": "write a haiku about ai"}
]
}'
```

```javascript Node.js
import OpenAI from "openai";

const openai = new OpenAI(
api_key="$UNDRSTND_API_KEY",
base_url="https://api.undrstnd-labs.com/v1"
)

const completion = await openai.chat.completions.create({
model: "llama3-8b-8192",
messages: [
{"role": "user", "content": "write a haiku about ai"}
]
});
```

```python Python
from openai import OpenAI

client = OpenAI(
api_key="$UNDRSTND_API_KEY",
base_url="https://api.undrstnd-labs.com/v1"
)

completion = client.chat.completions.create(
model="llama3-8b-8192",
messages=[
{"role": "user", "content": "write a haiku about ai"}
]
)
```

</CodeGroup>
</Card>

## Meet the models

<CardGroup cols={2}>
<Card title="Llama 3.1 70B Versatile">
Neque porro quisquam est qui dolorem ipsum quia dolor sit amet
</Card>
<Card title="Second Card">
Lorem ipsum dolor sit amet, consectetur adipiscing elit
</Card>
<Card title="Third Card">
Ut enim ad minim veniam, quis nostrud exercitation ullamco
</Card>
<Card title="Fourth Card">
Excepteur sint occaecat cupidatat non proident
</Card>
</CardGroup>
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Quickstart"
icon: "bolt"
description: "Get started with Undrstnd Developers and integrate powerful AI capabilities into your projects. This guide will walk you through getting an API key, making your first API request, and checking model statuses."
---

Binary file removed get-started/._quickstart.mdx
Binary file not shown.
148 changes: 0 additions & 148 deletions get-started/devBackup

This file was deleted.

83 changes: 0 additions & 83 deletions get-started/introductionBackup

This file was deleted.

Loading