vrr/eigent
2
0
Fork 0
mirror of https://github.com/eigent-ai/eigent.git synced 2026-07-10 01:38:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
eigent/docs/CONTENT_STRUCTURE.md
Tong Chen 97d7554438
Some checks failed
CodeQL Advanced / Analyze (actions) (push) Has been cancelled
Details
CodeQL Advanced / Analyze (javascript-typescript) (push) Has been cancelled
Details
CodeQL Advanced / Analyze (python) (push) Has been cancelled
Details
Pre-commit / pre-commit (push) Has been cancelled
Details
Test / Run Web + Local Brain Smoke (push) Has been cancelled
Details
Test / Run Frontend Guardrails (push) Has been cancelled
Details
Test / Run Python Tests (push) Has been cancelled
Details
release: Eigent 1.0.0 (#1695) 
Co-authored-by: Douglas <douglas.ym.lai@gmail.com>
Co-authored-by: Douglas Lai <115660088+Douglasymlai@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Tao Sun <168447269+fengju0213@users.noreply.github.com>
Co-authored-by: Weijie Bai <happy.regina.bai@gmail.com>
2026-06-17 00:29:35 +08:00

2.8 KiB
Raw Permalink Blame History

Eigent Documentation Structure

This file is the editorial map for the public Mintlify documentation. Navigation is defined in docs/docs.json. Writing and media conventions are defined in docs/STYLE_GUIDE.md.

Information Architecture

Get Started

  • Welcome and product positioning
  • Installation
  • Quick start
  • Self-hosting
  • Core concepts

Dashboard

  • Dashboard overview
  • Spaces
  • Projects
  • Tasks
  • Search, sort, grid, list, and board views

Projects

  • Space, Project, Session, and Run hierarchy
  • Project creation
  • Workspace landing
  • Context and files
  • Live sessions
  • Multi-run follow-ups
  • Single Agent mode
  • Workforce mode

Agents

  • Agent capabilities
  • Workers
  • Agent Skills
  • Remote sub-agents
  • Memory roadmap

Models

  • Model selection overview
  • Eigent Cloud
  • Bring Your Own Key
  • Local models
  • Provider reference
  • Provider-specific setup guides

Connectors

  • Connector overview
  • MCP marketplace
  • Custom local and remote MCP servers
  • Google Search
  • Tool assignment

Browser

  • Browser automation overview
  • CDP browser connections
  • Browser cookie management
  • Browser Plugins roadmap

Automation

  • Automation overview
  • Scheduled triggers
  • Webhook and Slack triggers
  • Dispatch and remote control
  • Execution logs and retries

Settings

  • Account, language, proxy, and updates
  • Appearance and custom themes
  • Privacy and data handling

Open Source

  • Repository and contribution overview
  • Self-hosting
  • Brain architecture

Provider Coverage

The provider reference must remain synchronized with src/lib/llm.ts and src/pages/Agents/localModels.ts.

Cloud and BYOK coverage:

  • Gemini
  • OpenAI
  • Anthropic
  • OrcaRouter
  • OpenRouter
  • Qwen
  • DeepSeek
  • MiniMax
  • Z.ai
  • Moonshot
  • ModelArk
  • SambaNova
  • Grok
  • Mistral
  • AWS Bedrock
  • AWS Bedrock Converse
  • Azure
  • ERNIE
  • OpenAI-compatible endpoints

Local runtime coverage:

  • Ollama
  • vLLM
  • SGLang
  • LM Studio
  • LLaMA.cpp

Editorial Priorities

  1. Capture current screenshots for Dashboard, Workspace, Context, Models, Connectors, Browser, and Triggers.
  2. Replace outline language with task-focused procedures.
  3. Add provider credential and endpoint examples.
  4. Add self-hosting commands and environment configuration.
  5. Add troubleshooting links from every setup guide.
  6. Mark coming-soon features clearly and remove those labels only when shipped.

Maintenance Checks

  • Every route in docs/docs.json must resolve to a Markdown file.
  • Every page must include title and description frontmatter.
  • Feature names should match current UI labels.
  • Model providers should be audited whenever src/lib/llm.ts changes.
  • Local runtimes should be audited whenever src/pages/Agents/localModels.ts changes.
  • Coming-soon features must not be described as generally available.