This directory contains the Mintlify documentation for Eigent. The docs are hosted via Mintlify and configured through docs.json.
Install the Mintlify CLI globally:
npm install -g mintlifyRun the dev server from inside the docs/ directory:
cd docs mintlify devThis starts a local server at http://localhost:3000 with hot reload on file changes.
docs/ ├── docs.json # Mintlify config: theme, navigation, branding ├── images/ # Logos and favicon ├── get_started/ # Welcome, installation, quick start ├── core/ # Concepts, workforce, tools, workers, skills │ └── models/ # Per-model setup guides (BYOK, Gemini, Kimi, etc.) └── troubleshooting/ # Bug reporting, support - Create a
.mdfile in the appropriate section folder (e.g.core/my-feature.md). - Add a frontmatter title at the top:
--- title: "My Feature" description: "Short description shown in search and meta." ---
- Register the page in
docs.jsonundernavigation.tabs[0].groupsin the relevant group'spagesarray:Note: paths omit the"/core/my-feature".mdextension and are relative todocs/.
Edit the .md file directly. Mintlify uses standard Markdown with some extended components (callouts, cards, tabs, etc.) — see the Mintlify docs for available components.
All site-level settings live in docs.json:
- Navigation order — edit the
pagesarrays insidenavigation.tabs[0].groups - Nested groups — add an object with
group,icon, andpagesin place of a plain path string - Theme / colors / logo — edit the top-level fields (
theme,colors,logo,favicon) - Navbar links — edit
navbar.linksandnavbar.primary - Footer socials — edit
footer.socials
Docs are deployed automatically by Mintlify on every push to the connected branch. No manual deploy step is needed — merging to main triggers a rebuild.