elizaOS Documentation

Welcome to the official documentation repository for elizaOS - a powerful framework for building AI agents with memory, planning, and tool use capabilities.

📚 About This Documentation

This repository contains the comprehensive documentation for elizaOS, including:

• Getting Started - Quick setup guides and tutorials
• Core Concepts - Understanding agents, plugins, and the architecture
• Deep Dive - Advanced topics like memory systems, services, and event handling
• REST Reference - Complete REST API documentation for all modules
• Examples - Real-world implementations and patterns

Development

Prerequisites

• Node.js (v23 or higher)
• bun (or npm/yarn)

Local Development Setup

Install the Mintlify CLI to preview the documentation changes locally:

bun install -g mint

Running Locally

Navigate to the root of your documentation (where docs.json is located) and run:

mint dev

This will start a local development server at http://localhost:3000 where you can preview your changes in real-time.

Project Structure

docs/
├── rest-reference/      # REST API documentation
├── core-concepts/      # Core concepts and architecture
├── deep-dive/         # Advanced topics
├── images/            # Documentation images
├── logo/              # Logo assets
├── snippets/          # Reusable code snippets
├── docs.json          # Mintlify configuration
├── index.mdx          # Landing page
├── quickstart.mdx     # Quick start guide
└── development.mdx    # Development guide

📝 Contributing to Documentation

We welcome contributions to improve the elizaOS documentation! Here's how you can help:

1. Fork this repository
2. Create a new branch for your changes
3. Make your documentation improvements
4. Test locally using mint dev
5. Submit a pull request

Documentation Guidelines

• Use clear, concise language
• Include code examples where appropriate
• Follow the existing structure and formatting
• Test all code snippets
• Add images/diagrams for complex concepts

Publishing Changes

Changes are automatically deployed when merged to the main branch. The documentation is hosted using Mintlify's infrastructure.

Deployment Process

1. Install the Mintlify GitHub App on your repository
2. Push changes to your default branch
3. Changes will be automatically deployed to production

Find the installation link in your Mintlify dashboard.

🔧 Troubleshooting

Common Issues

• Dev environment not running

  • Run mint update to ensure you have the latest version of the CLI
  • Check that you're in the correct directory with docs.json

• Page loads as 404

  • Ensure you're running the command in a folder containing docs.json
  • Check that your page is properly listed in the navigation

• Changes not reflecting

  • Clear your browser cache
  • Restart the development server
  • Check for syntax errors in your MDX files

📖 Learn More

• elizaOS GitHub Repository
• Mintlify Documentation
• MDX Documentation

📄 License

This documentation is part of the elizaOS project. Please refer to the main repository for license information.

Built with ❤️ using Mintlify