chore: Update README and add Mintlify docs
* Update README and add Mintlify docs * Add Twilio documentation * Remove license and fix readme
53
docs/CLAUDE.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
# Mintlify documentation
|
||||
|
||||
## Working relationship
|
||||
|
||||
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
|
||||
- ALWAYS ask for clarification rather than making assumptions
|
||||
- NEVER lie, guess, or make up information
|
||||
|
||||
## Project context
|
||||
|
||||
- Format: MDX files with YAML frontmatter
|
||||
- Config: docs.json for navigation, theme, settings
|
||||
- Components: Mintlify components
|
||||
|
||||
## Content strategy
|
||||
|
||||
- Document just enough for user success - not too much, not too little
|
||||
- Prioritize accuracy and usability of information
|
||||
- Make content evergreen when possible
|
||||
- Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason
|
||||
- Check existing patterns for consistency
|
||||
- Start by making the smallest reasonable changes
|
||||
|
||||
## Frontmatter requirements for pages
|
||||
|
||||
- title: Clear, descriptive page title
|
||||
- description: Concise summary for SEO/navigation
|
||||
|
||||
## Writing standards
|
||||
|
||||
- Second-person voice ("you")
|
||||
- Prerequisites at start of procedural content
|
||||
- Test all code examples before publishing
|
||||
- Match style and formatting of existing pages
|
||||
- Include both basic and advanced use cases
|
||||
- Language tags on all code blocks
|
||||
- Alt text on all images
|
||||
- Relative paths for internal links
|
||||
|
||||
## Git workflow
|
||||
|
||||
- NEVER use --no-verify when committing
|
||||
- Ask how to handle uncommitted changes before starting
|
||||
- Create a new branch when no clear branch exists for changes
|
||||
- Commit frequently throughout development
|
||||
- NEVER skip or disable pre-commit hooks
|
||||
|
||||
## Do not
|
||||
|
||||
- Skip frontmatter on any MDX file
|
||||
- Use absolute URLs for internal links
|
||||
- Include untested code examples
|
||||
- Make assumptions - always ask for clarification
|
||||
7
docs/README.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# Dograh AI Documentation
|
||||
|
||||
### Local Setup
|
||||
|
||||
1. Install mintlify `npm i -g mint`
|
||||
1. Clone the repository
|
||||
1. `cd dograh/docs` and run `mint dev`
|
||||
75
docs/docs.json
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
{
|
||||
"$schema": "https://mintlify.com/docs.json",
|
||||
"theme": "mint",
|
||||
"name": "Dograh AI",
|
||||
"colors": {
|
||||
"primary": "#16A34A",
|
||||
"light": "#07C983",
|
||||
"dark": "#15803D"
|
||||
},
|
||||
"favicon": "/favicon.ico",
|
||||
"navigation": {
|
||||
"tabs": [
|
||||
{
|
||||
"tab": "Guides",
|
||||
"groups": [
|
||||
{
|
||||
"group": "Getting started",
|
||||
"pages": [
|
||||
{
|
||||
"group": "Introduction",
|
||||
"pages": [
|
||||
"getting-started/index",
|
||||
"getting-started/prerequisites",
|
||||
"getting-started/troubleshooting"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Telephony Integrations",
|
||||
"pages": [
|
||||
"telephony/twilio"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"logo": {
|
||||
"light": "/logo/light.svg",
|
||||
"dark": "/logo/dark.svg",
|
||||
"href": "https://docs.dograh.com"
|
||||
},
|
||||
"navbar": {
|
||||
"links": [
|
||||
{
|
||||
"label": "Support",
|
||||
"href": "https://github.com/dograh-hq/dograh/issues/new/choose"
|
||||
}
|
||||
],
|
||||
"primary": {
|
||||
"type": "button",
|
||||
"label": "Dashboard",
|
||||
"href": "https://app.dograh.com"
|
||||
}
|
||||
},
|
||||
"contextual": {
|
||||
"options": [
|
||||
"copy",
|
||||
"view",
|
||||
"chatgpt",
|
||||
"claude",
|
||||
"perplexity",
|
||||
"mcp",
|
||||
"cursor",
|
||||
"vscode"
|
||||
]
|
||||
},
|
||||
"footer": {
|
||||
"socials": {
|
||||
"github": "https://github.com/dograh-hq",
|
||||
"linkedin": "https://linkedin.com/company/dograh"
|
||||
}
|
||||
}
|
||||
}
|
||||
BIN
docs/favicon.ico
Normal file
|
After Width: | Height: | Size: 24 KiB |
26
docs/getting-started/index.mdx
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
title: "Introduction"
|
||||
description: "Welcome to Dograh AI documentation"
|
||||
---
|
||||
|
||||
## Setting up
|
||||
|
||||
Get the stack up and running using Docker with a single command.
|
||||
|
||||
<Note>We collect anonymous usage data to improve the product. You can opt out by setting the `ENABLE_TELEMETRY` to `false` in the below command.</Note>
|
||||
|
||||
```bash
|
||||
curl -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/main/docker-compose.yaml && REGISTRY=ghcr.io/dograh-hq ENABLE_TELEMETRY=true docker compose up
|
||||
```
|
||||
|
||||
Please check [Prerequisites](getting-started/prerequisites) for the system requirements and [Troubleshooting](getting-started/troubleshooting) for common issues.
|
||||
|
||||
You can also watch below video to see the setup in action.
|
||||
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.tella.tv/video/cmgbysbsz00kw0bjm2qnc5f1d/embed?b=1&title=1&a=1&loop=0&t=0&muted=0&wt=1"
|
||||
title="Dogrh Getting Started"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
|
@ -1,4 +1,7 @@
|
|||
# Prerequisites
|
||||
---
|
||||
title: "Prerequisites"
|
||||
description: "System requirements and setup needed to run Dograh AI"
|
||||
---
|
||||
|
||||
## System Requirements
|
||||
|
||||
|
|
@ -6,8 +9,8 @@
|
|||
- **RAM**: 8 GB (4 GB available for Docker)
|
||||
- **Storage**: 10 GB free disk space
|
||||
- **CPU**: 2 cores (x86_64 or ARM64)
|
||||
- **OS**:
|
||||
- macOS 10.15+ (Catalina or newer)\
|
||||
- **OS**:
|
||||
- macOS 10.15+ (Catalina or newer)
|
||||
- Windows 10/11 with WSL2
|
||||
- Linux with kernel 3.10+
|
||||
|
||||
|
|
@ -16,13 +19,16 @@
|
|||
To run Dograh AI locally, make sure you have the following installed:
|
||||
|
||||
- [Docker](https://docs.docker.com/get-docker/) (version 20.10 or later)
|
||||
- [curl](https://curl.se/download.html) usually preinstalled on macOS/Linux
|
||||
- [curl](https://curl.se/download.html) - usually preinstalled on macOS/Linux
|
||||
|
||||
> **Note**
|
||||
> Docker Compose is included with Docker Desktop. Make sure Docker is running before you begin.
|
||||
<Note>
|
||||
Docker Compose is included with Docker Desktop. Make sure Docker is running before you begin.
|
||||
</Note>
|
||||
|
||||
### Docker Resource Allocation
|
||||
|
||||
For Docker Desktop users, ensure Docker has adequate resources:
|
||||
|
||||
1. Open Docker Desktop settings
|
||||
2. Navigate to Resources
|
||||
3. Allocate at least:
|
||||
|
|
@ -33,6 +39,7 @@ For Docker Desktop users, ensure Docker has adequate resources:
|
|||
## Required Ports
|
||||
|
||||
Ensure these ports are available:
|
||||
|
||||
- `3010` - Web UI
|
||||
- `8000` - API Server
|
||||
- `5432` - PostgreSQL
|
||||
|
|
@ -42,23 +49,37 @@ Ensure these ports are available:
|
|||
|
||||
## Checking Port Availability
|
||||
|
||||
##### Check if a port is in use (replace 3010 with the port number)
|
||||
```bash
|
||||
Check if a port is in use (replace 3010 with the port number):
|
||||
|
||||
<CodeGroup>
|
||||
|
||||
```bash macOS/Linux
|
||||
lsof -i :3010
|
||||
```
|
||||
|
||||
```bash Linux (alternative)
|
||||
netstat -tulpn | grep 3010
|
||||
```
|
||||
|
||||
```bash Windows (PowerShell)
|
||||
netstat -ano | findstr :3010
|
||||
```
|
||||
|
||||
</CodeGroup>
|
||||
|
||||
## Docker Registry Options
|
||||
|
||||
Dograh images are available from two registries that you can choose from:
|
||||
Dograh images are available from two registries:
|
||||
|
||||
- **GitHub Container Registry (Default)**: `ghcr.io/dograh-hq` - Recommended for most users
|
||||
- **Docker Hub**: `dograhai` - Alternative registry
|
||||
|
||||
To use a specific registry, set the `REGISTRY` environment variable using either of the following:
|
||||
To use a specific registry, set the `REGISTRY` environment variable:
|
||||
|
||||
##### Using GitHub Container Registry (recommended) or Docker Hub
|
||||
```bash
|
||||
# Using GitHub Container Registry (recommended)
|
||||
REGISTRY=ghcr.io/dograh-hq docker compose up
|
||||
|
||||
# Using Docker Hub
|
||||
REGISTRY=dograhai docker compose up
|
||||
```
|
||||
```
|
||||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Troubleshooting"
|
||||
description: "Common issues and solutions for running Dograh AI"
|
||||
---
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
## Freeing Up Ports
|
||||
|
|
@ -42,4 +47,4 @@ docker inspect -f '{{.Name}} - {{.HostConfig.RestartPolicy.Name}}' $(docker ps -
|
|||
docker compose down
|
||||
|
||||
docker compose down -v
|
||||
```
|
||||
```
|
||||
BIN
docs/images/checks-passed.png
Normal file
|
After Width: | Height: | Size: 157 KiB |
BIN
docs/images/hero-dark.png
Normal file
|
After Width: | Height: | Size: 108 KiB |
BIN
docs/images/hero-light.png
Normal file
|
After Width: | Height: | Size: 102 KiB |
BIN
docs/images/video_thumbnail.png
Normal file
|
After Width: | Height: | Size: 552 KiB |
3
docs/logo/dark.svg
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
<svg width="120" height="30" viewBox="0 0 120 30" xmlns="http://www.w3.org/2000/svg">
|
||||
<text x="5" y="22" font-family="Arial, sans-serif" font-size="20" font-weight="bold" fill="#FFFFFF">Dograh AI</text>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 212 B |
3
docs/logo/light.svg
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
<svg width="120" height="30" viewBox="0 0 120 30" xmlns="http://www.w3.org/2000/svg">
|
||||
<text x="5" y="22" font-family="Arial, sans-serif" font-size="20" font-weight="bold" fill="#000000">Dograh AI</text>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 212 B |
15
docs/telephony/twilio.mdx
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: "Twilio"
|
||||
description: "Setting up Twilio on Dograh AI"
|
||||
---
|
||||
|
||||
### Introduction
|
||||
You can setup Twilio on Dograh AI to make and receive calls when executing your Voice Agent Workflow. You can watch below video to get started with the setup once you have your Dograh AI stack running.
|
||||
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.tella.tv/video/cmgbvzkrt00jk0clacu16blm3/embed?b=1&title=1&a=1&loop=0&t=0&muted=0&wt=1"
|
||||
title="Dogrh Twilio Setup"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||