Skip to content

Commit

Permalink
feat: WIP add mintlify docs
Browse files Browse the repository at this point in the history
  • Loading branch information
transitive-bullshit committed Aug 8, 2024
1 parent 3b1f6c3 commit 20d468c
Show file tree
Hide file tree
Showing 11 changed files with 3,632 additions and 75 deletions.
15 changes: 15 additions & 0 deletions docs/intro.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'Agentic'
description: 'AI agent stdlib that works with any LLM and TypeScript AI SDK.'
---

Agentic is a **standard library of AI tools** which are **optimized for both normal TS-usage as well as LLM-based usage**.

Agentic works with any LLM capable of function calling and the following TS AI SDKs:

- Vercel AI SDK
- LangChain
- LlamaIndex
- Firebase Genkit
- Dexa Dexter
- OpenAI
10 changes: 10 additions & 0 deletions docs/media/agentic-logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions docs/media/agentic-logo-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/favicon.ico
Binary file not shown.
9 changes: 9 additions & 0 deletions docs/media/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 66 additions & 0 deletions docs/mint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
{
"$schema": "https://mintlify.com/schema.json",
"name": "Agentic",
"logo": {
"dark": "/media/agentic-logo-dark.svg",
"light": "/media/agentic-logo-light.svg"
},
"favicon": "/media/favicon.svg",
"colors": {
"primary": "#DD5130",
"light": "#F76340",
"dark": "#DD5130",
"anchors": {
"from": "#DD5130",
"to": "#F76340"
}
},
"topbarLinks": [
{
"name": "Twitter",
"url": "https://x.com/transitive_bs"
}
],
"topbarCtaButton": {
"name": "GitHub",
"url": "https://github.com/transitive-bullshit/agentic"
},
"anchors": [
{
"name": "GitHub",
"icon": "github",
"url": "https://github.com/transitive-bullshit/agentic"
}
],
"navigation": [
{
"group": "Getting Started",
"pages": [
"intro",
"quickstart",
"usage",
{
"group": "AI SDKs",
"pages": [
"sdks/ai-sdk",
"sdks/langchain",
"sdks/llamaindex",
"sdks/genkit",
"sdks/dexter"
]
}
]
},
{
"group": "Tools",
"pages": ["tools/bing", "tools/weather"]
}
],
"footerSocials": {
"x": "https://x.com/transitive_bs",
"github": "https://github.com/transitive-bullshit/agentic"
},
"seo": {
"indexHiddenPages": true
}
}
208 changes: 208 additions & 0 deletions docs/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,208 @@
---
title: 'Quick Start'
---

## Install

<Info>
**Prerequisite**: All Agentic packages are [ESM
only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c)
and require `Node.js >= 18` or an equivalent environment (Bun, Deno, CF
workers, etc).
</Info>

<Steps>
<Step title='Install core deps'>
<CodeGroup>
```bash npm
npm install @agentic/core zod
```

```bash yarn
yarn add @agentic/core zod
```

```bash pnpm
pnpm add @agentic/core zod
```
</CodeGroup>

</Step>

<Step title='Install AI tools'>
You can either install all of the AI tools via the convenience package `@agentic/stdlib`, or you can install them individually via their respective packages (`@agentic/weather`, `@agentic/twitter`, etc.).

<AccordionGroup>
<Accordion title="Install all AI tools">
<CodeGroup>
```bash npm
npm install @agentic/stdlib
```

```bash yarn
yarn add @agentic/stdlib
```

```bash pnpm
pnpm add @agentic/stdlib
```
</CodeGroup>
</Accordion>

<Accordion title="Install individual AI tools">
Docs for individual tools are available [here](/tools).

Here's an example of how to install the `@agentic/calculator` tool:
<CodeGroup>
```bash npm
npm install @agentic/calculator
```
```bash yarn
yarn add @agentic/calculator
```
```bash pnpm
pnpm add @agentic/calculator
```
</CodeGroup>
</Accordion>
</AccordionGroup>
<Note>
There is no functional difference between using `@agentic/stdlib` versus using the individual tool packages directly. The only difference is if you want to optimize your install size (when running on serverless functions, for instance).
The default examples all use `@agentic/stdlib` because it provides a simpler DX.
</Note>
</Step>
<Step title='Install an AI SDK Adapter'>
To use Agentic with one of the supported AI SDKs, you'll also need to install its corresponding adapter package.

<AccordionGroup>
<Accordion title="Vercel AI SDK">
<CodeGroup>
```bash npm
npm install @agentic/ai-sdk ai
```

```bash yarn
yarn add @agentic/ai-sdk ai
```

```bash pnpm
pnpm add @agentic/ai-sdk ai
```
</CodeGroup>

See the [Agentic ⇒ Vercel AI SDK](/sdks/ai-sdk) docs for more details.
</Accordion>

<Accordion title="LangChain">
<CodeGroup>
```bash npm
npm install @agentic/langchain @langchain/core langchain
```

```bash yarn
yarn add @agentic/langchain @langchain/core langchain
```

```bash pnpm
pnpm add @agentic/langchain @langchain/core langchain
```
</CodeGroup>

See the [Agentic ⇒ LangChain](/sdks/langchain) docs for more details.
</Accordion>

<Accordion title="LlamaIndex">
<CodeGroup>
```bash npm
npm install @agentic/llamaindex llamaindex
```

```bash yarn
yarn add @agentic/llamaindex llamaindex
```

```bash pnpm
pnpm add @agentic/llamaindex llamaindex
```
</CodeGroup>

See the [Agentic ⇒ LlamaIndex](/sdks/llamaindex) docs for more details.
</Accordion>

<Accordion title="Firebase Genkit">
<CodeGroup>
```bash npm
npm install @agentic/genkit @genkit-ai/ai @genkit-ai/core
```

```bash yarn
yarn add @agentic/genkit @genkit-ai/ai @genkit-ai/core
```

```bash pnpm
pnpm add @agentic/genkit @genkit-ai/ai @genkit-ai/core
```
</CodeGroup>

See the [Agentic ⇒ Genkit](/sdks/genkit) docs for more details.
</Accordion>

<Accordion title="Dexa Dexter">
<CodeGroup>
```bash npm
npm install @agentic/dexter @dexaai/dexter
```

```bash yarn
yarn add @agentic/dexter @dexaai/dexter
```

```bash pnpm
pnpm add @agentic/dexter @dexaai/dexter
```
</CodeGroup>

See the [Agentic ⇒ Dexter](/sdks/dexter) docs for more details.
</Accordion>

<Accordion title="OpenAI SDK">
<CodeGroup>
```bash npm
npm install openai
```

```bash yarn
yarn add openai
```

```bash pnpm
pnpm add openai
```
</CodeGroup>

There's no need for a separate adapter with the OpenAI SDK since all agentic tools are compatible with OpenAI by default. You can use `AIFunctionSet.specs` for function calling or `AIFunctionSet.toolSpecs` for parallel tool calling.
See the [Agentic ⇒ OpenAI](/sdks/openai) docs for more details.
</Accordion>
</AccordionGroup>
<Note>
You can use Agentic without any of these AI SDKs. `@agentic/core` and all tool packages are completely agnostic to the specific LLM and AI SDK.
</Note>
</Step>
</Steps>
## Usage
TODO
Loading

0 comments on commit 20d468c

Please sign in to comment.