Codex/skill docs update - New PR with correct video formate (#1387)
Some checks failed
Pre-commit / pre-commit (push) Has been cancelled
Test / Run Python Tests (push) Has been cancelled
CodeQL Advanced / Analyze (actions) (push) Has been cancelled
CodeQL Advanced / Analyze (javascript-typescript) (push) Has been cancelled
CodeQL Advanced / Analyze (python) (push) Has been cancelled
Co-authored-by: Tao Sun <168447269+fengju0213@users.noreply.github.com> Co-authored-by: Sun Tao <2605127667@qq.com>
68
docs/README.md
Normal file
|
|
@ -0,0 +1,68 @@
|
|||
# Eigent Docs
|
||||
|
||||
This directory contains the Mintlify documentation for [Eigent](https://www.eigent.ai). The docs are hosted via Mintlify and configured through `docs.json`.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Install the Mintlify CLI globally:
|
||||
|
||||
```bash
|
||||
npm install -g mintlify
|
||||
```
|
||||
|
||||
## Preview locally
|
||||
|
||||
Run the dev server from inside the `docs/` directory:
|
||||
|
||||
```bash
|
||||
cd docs
|
||||
mintlify dev
|
||||
```
|
||||
|
||||
This starts a local server at `http://localhost:3000` with hot reload on file changes.
|
||||
|
||||
## File structure
|
||||
|
||||
```
|
||||
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
|
||||
```
|
||||
|
||||
## Adding a new page
|
||||
|
||||
1. Create a `.md` file in the appropriate section folder (e.g. `core/my-feature.md`).
|
||||
2. Add a frontmatter title at the top:
|
||||
```md
|
||||
---
|
||||
title: "My Feature"
|
||||
description: "Short description shown in search and meta."
|
||||
---
|
||||
```
|
||||
3. Register the page in `docs.json` under `navigation.tabs[0].groups` in the relevant group's `pages` array:
|
||||
```json
|
||||
"/core/my-feature"
|
||||
```
|
||||
Note: paths omit the `.md` extension and are relative to `docs/`.
|
||||
|
||||
## Updating an existing page
|
||||
|
||||
Edit the `.md` file directly. Mintlify uses standard Markdown with some extended components (callouts, cards, tabs, etc.) — see the [Mintlify docs](https://mintlify.com/docs) for available components.
|
||||
|
||||
## Updating navigation or config
|
||||
|
||||
All site-level settings live in `docs.json`:
|
||||
|
||||
- **Navigation order** — edit the `pages` arrays inside `navigation.tabs[0].groups`
|
||||
- **Nested groups** — add an object with `group`, `icon`, and `pages` in place of a plain path string
|
||||
- **Theme / colors / logo** — edit the top-level fields (`theme`, `colors`, `logo`, `favicon`)
|
||||
- **Navbar links** — edit `navbar.links` and `navbar.primary`
|
||||
- **Footer socials** — edit `footer.socials`
|
||||
|
||||
## Deployment
|
||||
|
||||
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.
|
||||
71
docs/core/agent-skills.md
Normal file
|
|
@ -0,0 +1,71 @@
|
|||
---
|
||||
title: 'Agent Skills'
|
||||
description: 'Learn how to use built-in and custom Agent Skills in Eigent.'
|
||||
---
|
||||
|
||||
Agent Skills, a concept originally introduced by Anthropic, are modular capabilities designed to expand Eigent's core capabilities.
|
||||
|
||||
Each Skill acts as a specialized package containing instructions, metadata, and optional tools (such as scripts or templates) that Eigent automatically triggers whenever relevant to a task.
|
||||
|
||||
## The Value of Using Skills
|
||||
|
||||
While traditional prompts act as one-off instructions for a single conversation, Skills are persistent, file-based assets that provide Eigent with deep, domain-specific expertise.
|
||||
|
||||
By supplying tailored workflows, context, and best practices, Skills transform a general-purpose AI into a dedicated specialist.
|
||||
|
||||
Because they load seamlessly on demand, you never have to waste time copy-pasting the same instructions across multiple chats.
|
||||
|
||||
**Key benefits**:
|
||||
|
||||
- **Specialize Eigent**: Tailor capabilities for domain-specific tasks
|
||||
- **Reduce repetition**: Create once, use automatically
|
||||
- **Compose capabilities**: Combine Skills to build complex workflows
|
||||
|
||||
## Using Skills in Eigent
|
||||
|
||||
Eigent provides pre-built Agent Skills for common tasks, and you can create or upload your own custom Skills. Eigent automatically uses them when relevant to your request.
|
||||
|
||||
- **Example Skills:** These are pre-built Agent Skills available to all users on Eigent. They operate seamlessly behind the scenes, and Eigent utilizes them without requiring any manual setup. You have the option to manually enable or disable it.
|
||||
|
||||
<video controls className="w-full aspect-video rounded-xl" src="/docs/images/agent_skills_example_skills_04.mp4"></video>
|
||||
|
||||
- **Custom Skills:** These allow you to package your specific domain expertise and organizational knowledge. They are available across your Eigent workforce, and you can assign them to specific agents. You can create them directly within the Skill interface or add them via Eigent's settings.
|
||||
|
||||

|
||||
|
||||
Upload your own Skills as zip files through Homepage > Agents > Skills. Custom Skills are individual to each user and saved locally.
|
||||
|
||||
<video controls className="w-full aspect-video rounded-xl" src="/docs/images/agent_skills_skill01.mp4"></video>
|
||||
|
||||
You can upload a standalone `SKILL.md` file or a complete `.zip` skill package. If uploading a package, it must contain a `SKILL.md` file in its root directory. In either case, the `SKILL.md` file must define the Skill's name and description using YAML formatting.
|
||||
|
||||
<video controls className="w-full aspect-video rounded-xl" src="/docs/images/agent_skills_skill02.mp4"></video>
|
||||
|
||||
Every Skill requires a `SKILL.md` file with YAML frontmatter:
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: your-skill-name
|
||||
description: Brief description of what this Skill does and when to use it
|
||||
---
|
||||
|
||||
# Your Skill Name
|
||||
|
||||
## Instructions
|
||||
[Clear, step-by-step guidance for Eigent to follow]
|
||||
|
||||
## Examples
|
||||
[Concrete examples of using this Skill]
|
||||
```
|
||||
|
||||
Eigent supports uploading multiple skills within one zip file, but please ensure the contents of each skill folder are complete.
|
||||
|
||||
<video controls className="w-full aspect-video rounded-xl" src="/docs/images/agent_skills_skills_05.mp4"></video>
|
||||
|
||||
## Using Skills
|
||||
|
||||
To test your Skill file immediately, click the **Try in chat** button.
|
||||
|
||||
<video controls className="w-full aspect-video rounded-xl" src="/docs/images/agent_skills_skill03.mp4"></video>
|
||||
|
||||
Use Skills only from trusted sources. Malicious Skills can misuse tools or execute unintended actions, potentially causing data leaks or unauthorized access—so carefully audit any untrusted Skill before use.
|
||||
|
|
@ -21,17 +21,11 @@ description: Configure your own API keys to use various LLM providers with Eigen
|
|||
|
||||
### Step 2: Configure in Eigent
|
||||
|
||||
1. Launch Eigent and go to **Settings** > **Models**
|
||||
1. Launch Eigent and go to **Agent** > **Models**
|
||||
|
||||
1. Find the **OpenAI** card in the Custom Model section
|
||||
|
||||
\<img
|
||||
src="/images/Screenshot2026-01-20at18.13.45.png"
|
||||
alt="Screenshot 2026 01 20 At 18 13 45"
|
||||
title="Screenshot 2026 01 20 At 18 13 45"
|
||||
className="mr-auto"
|
||||
style={{ width:"74%" }}
|
||||
/>
|
||||

|
||||
|
||||
1. Fill in the following fields:
|
||||
|
||||
|
|
|
|||
|
|
@ -74,7 +74,8 @@
|
|||
]
|
||||
},
|
||||
"/core/tools",
|
||||
"/core/workers"
|
||||
"/core/workers",
|
||||
"/core/agent-skills"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
|
|
|||
|
|
@ -205,7 +205,7 @@ Congratulations on running your first task! Here are a few recommended reads to
|
|||
<Card
|
||||
title="Models"
|
||||
icon="server"
|
||||
href="/core/models">
|
||||
href="/core/models/byok">
|
||||
Discover how to connect your own local or cloud-based AI models.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 120 KiB |
|
Before Width: | Height: | Size: 117 KiB |
|
Before Width: | Height: | Size: 141 KiB |
BIN
docs/images/agent_skills_example_skills_04.mp4
Normal file
BIN
docs/images/agent_skills_settings_screenshot.png
Normal file
|
After Width: | Height: | Size: 82 KiB |
BIN
docs/images/agent_skills_skill01.mp4
Normal file
BIN
docs/images/agent_skills_skill02.mp4
Normal file
BIN
docs/images/agent_skills_skill03.mp4
Normal file
BIN
docs/images/agent_skills_skills_05.mp4
Normal file
BIN
docs/images/byok_1.png
Normal file
|
After Width: | Height: | Size: 209 KiB |
BIN
docs/images/favicon.png
Normal file
|
After Width: | Height: | Size: 8.3 KiB |
BIN
docs/images/logo-dark.png
Normal file
|
After Width: | Height: | Size: 4.2 KiB |
BIN
docs/images/logo-light.png
Normal file
|
After Width: | Height: | Size: 3.9 KiB |
BIN
docs/images/logo_black.png
Normal file
|
After Width: | Height: | Size: 3.9 KiB |
BIN
docs/images/logo_white.png
Normal file
|
After Width: | Height: | Size: 4.2 KiB |