Welcome to the official documentation repository for ElizaOS - a powerful framework for building AI agents with memory, planning, and tool use capabilities.
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
- API Reference - Complete API documentation for all modules
- Examples - Real-world implementations and patterns
- Node.js (v23 or higher)
- bun (or npm/yarn)
Install the Mintlify CLI to preview the documentation changes locally:
bun install -g mint
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.
docs/
├── api-reference/ # 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
We welcome contributions to improve the ElizaOS documentation! Here's how you can help:
- Fork this repository
- Create a new branch for your changes
- Make your documentation improvements
- Test locally using
mint dev
- Submit a pull request
- 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
Changes are automatically deployed when merged to the main branch. The documentation is hosted using Mintlify's infrastructure.
- Install the Mintlify GitHub App on your repository
- Push changes to your default branch
- Changes will be automatically deployed to production
Find the installation link in your Mintlify dashboard.
-
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
- Run
-
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
- Ensure you're running the command in a folder containing
-
Changes not reflecting
- Clear your browser cache
- Restart the development server
- Check for syntax errors in your MDX files
This documentation is part of the ElizaOS project. Please refer to the main repository for license information.
Built with ❤️ using Mintlify