Source for the elizaOS documentation site, built with Mintlify. Covers the OS, runtime, app layer, Eliza Cloud, Chip, and Robot tracks.
Install the Mintlify CLI, then preview from this directory:
bun install -g mint
cd packages/docs
mint devThe preview starts at http://localhost:3000. Brand assets (logos, favicons, OG embeds, banners) are automatically synced from packages/shared before dev and build.
packages/docs/
├── docs.json # Mintlify site config: navigation, colors, fonts, logo
├── index.mdx # Home page
├── quickstart.mdx # Quickstart
├── tracks/ # Dimension-specific content (OS, Runtime, App, Cloud, Chip, Robot)
├── apps/ # App layer pages (desktop, mobile, dashboard, ui-library)
├── runtime/ # Runtime internals reference
├── agents/ # Agent internals reference
├── plugins/ # Plugin reference pages
├── cli/ # CLI reference
├── connectors/ # Connector pages (Discord, Telegram, iMessage, etc.)
├── cloud/ # Eliza Cloud reference
├── guides/ # How-to guides and tutorials
├── user/ # End-user guides
├── test/ # Test suite (nav integrity, broken links)
└── public/ # Static assets (auto-generated — do not hand-edit)
- Create a
.mdxor.mdfile in the appropriate directory. - Add its path (no extension) to the correct group in
docs.jsonundernavigation.tabs. - Run tests to catch missing pages and broken links:
bun run --cwd packages/docs test - Preview with
mint dev.
test/docs.test.js uses Node's built-in test runner. It validates:
docs.jsonis valid and has required Mintlify fields.- Navigation tabs and groups contain no duplicate labels or pages.
- Every page referenced in navigation exists on disk.
- All markdown files are non-empty.
- All internal links in markdown and MDX files resolve to real files.
Changes merged to the main branch are automatically deployed by the Mintlify GitHub App. The app must be installed on the repository and pointed at the default branch.
If a page shows as 404 after deploy, confirm the file path appears in docs.json navigation and that the Mintlify CLI shows no errors locally.