elizaOS Documentation

Documentation for elizaOS: an agent framework with memory, planning, and tool use.

Development

Prerequisites

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

Local Development Setup

Install the Mintlify CLI to preview documentation changes locally:

bun install -g mint

Running Locally

From the repository root:

cd packages/docs && mint dev

This starts a local preview, usually at http://localhost:3000. The repository root also has a docs symlink to packages/docs so existing docs/... paths keep resolving.

Project structure

packages/docs/
├── docs.json              # Mintlify configuration
├── rest/                  # REST API reference
├── guides/, plugins/      # Guides and reference content
├── images/, logo/
├── index.mdx
└── quickstart.mdx

Contributing

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 on Mintlify.

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.