Skip to content

Commit

Permalink
move docs (#217)
Browse files Browse the repository at this point in the history
  • Loading branch information
siyangqiu authored May 21, 2024
1 parent 3977cb9 commit 55af146
Show file tree
Hide file tree
Showing 36 changed files with 6,664 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Mintlify Starter Kit

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

Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command

```
npm i -g mintlify
```

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

```
mintlify dev
```

### 😎 Publishing Changes

Changes will be deployed to production automatically after pushing to the default branch.

You can also preview changes using PRs, which generates a preview link of the docs.

#### 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`
3 changes: 3 additions & 0 deletions docs/_snippets/snippet-example.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## My Snippet

<Info>This is an example of a reusable snippet</Info>
Binary file added docs/favicon.png
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/images/agent-name.png
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/images/api-keys.png
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/images/checks-passed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
361 changes: 361 additions & 0 deletions docs/images/hero-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
361 changes: 361 additions & 0 deletions docs/images/hero-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/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.
4 changes: 4 additions & 0 deletions docs/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.
85 changes: 85 additions & 0 deletions docs/mint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
{
"$schema": "https://mintlify.com/schema.json",
"name": "AgentOps",
"logo": {
"dark": "/logo/dark.svg",
"light": "/logo/light.svg"
},
"favicon": "/favicon.png",
"colors": {
"primary": "#9563FF",
"light": "#AE87FF",
"dark": "#0D001D",
"background": {
"dark": "#090014"
},
"anchors": {
"from": "#FF7F57",
"to": "#9563FF"
}
},
"topbarLinks": [
{
"name": "Support",
"url": "mailto:[email protected]"
}
],
"topbarCtaButton": {
"name": "Dashboard",
"url": "https://app.agentops.ai"
},
"navigation": [
{
"group": "Getting Started",
"pages": [
"v1/introduction",
"v1/installation",
"v1/quickstart",
"v1/examples"
]
},
{
"group": "Details",
"pages": [
"v1/details/core-concepts",
"v1/details/sdk-reference",
"v1/details/sessions",
"v1/details/events",
"v1/details/tags",
"v1/details/decorators",
"v1/details/recording-events",
"v1/details/tracking-agents",
"v1/details/tracking-llm-calls",
"v1/details/more-models-with-litellm"
]
},
{
"group": "Integrations",
"pages": ["v1/integrations/crewai", "v1/integrations/cohere"]
},{
"group": "Other Info",
"pages": [
"v1/details/host-env"
]
},
{
"group": "Integrations",
"pages": ["v1/integrations/crewai"]
},{
"group": "Other Info",
"pages": [
"v1/details/host-env"
]
}
],
"footerSocials": {
"twitter": "https://twitter.com/agentopsai",
"github": "https://github.com/AgentOps-AI"
},
"analytics": {
"posthog": {
"apiKey": "phc_BrY3H11IViWSoUJ0QFfjBx7kEwIJMT0PjBEXZQmddW",
"apiHost": "https://us.i.posthog.com"
}
}
}
Loading

0 comments on commit 55af146

Please sign in to comment.