Skip to content

Commit 9f5585f

Browse files
authored
📝 Update user-guide docs to fit new features
2 parents 063120a + 15fe9c5 commit 9f5585f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+1359
-833
lines changed

doc/docs/.vitepress/config.mts

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -55,25 +55,31 @@ export default defineConfig({
5555
{
5656
text: "User Guide",
5757
items: [
58-
{ text: "Quick Start", link: "/en/user-guide/" },
58+
{ text: "Home Page", link: "/en/user-guide/home-page" },
59+
{ text: "Start Chat", link: "/en/user-guide/start-chat" },
5960
{
60-
text: "App Configuration",
61-
link: "/en/user-guide/app-configuration",
61+
text: "Quick Setup",
62+
link: "/en/user-guide/quick-setup",
6263
},
64+
{ text: "Agent Space", link: "/en/user-guide/agent-space" },
65+
{ text: "Agent Market", link: "/en/user-guide/agent-market" },
6366
{
64-
text: "Model Configuration",
65-
link: "/en/user-guide/model-configuration",
67+
text: "Agent Development",
68+
link: "/en/user-guide/agent-development",
6669
},
6770
{
68-
text: "Knowledge Base Configuration",
69-
link: "/en/user-guide/knowledge-base-configuration",
71+
text: "Knowledge Base",
72+
link: "/en/user-guide/knowledge-base",
7073
},
7174
{
72-
text: "Agent Configuration",
73-
link: "/en/user-guide/agent-configuration",
75+
text: "Model Management",
76+
link: "/en/user-guide/model-management",
7477
},
75-
{ text: "Chat Interface", link: "/en/user-guide/chat-interface" },
76-
{ text: "Memory Configuration", link: "/en/user-guide/memory" },
78+
{
79+
text: "Memory Management",
80+
link: "/en/user-guide/memory-management",
81+
},
82+
{ text: "User Management", link: "/en/user-guide/user-management" },
7783
{
7884
text: "Local Tools",
7985
items: [
@@ -231,19 +237,22 @@ export default defineConfig({
231237
{
232238
text: "用户指南",
233239
items: [
234-
{ text: "快速开始", link: "/zh/user-guide/" },
235-
{ text: "应用配置", link: "/zh/user-guide/app-configuration" },
236-
{ text: "模型配置", link: "/zh/user-guide/model-configuration" },
240+
{ text: "首页", link: "/zh/user-guide/home-page" },
241+
{ text: "开始问答", link: "/zh/user-guide/start-chat" },
242+
{ text: "快速设置", link: "/zh/user-guide/quick-setup" },
243+
{ text: "智能体空间", link: "/zh/user-guide/agent-space" },
244+
{ text: "智能体市场", link: "/zh/user-guide/agent-market" },
237245
{
238-
text: "知识库配置",
239-
link: "/zh/user-guide/knowledge-base-configuration",
246+
text: "智能体开发",
247+
link: "/zh/user-guide/agent-development",
240248
},
241249
{
242-
text: "智能体配置",
243-
link: "/zh/user-guide/agent-configuration",
250+
text: "知识库",
251+
link: "/zh/user-guide/knowledge-base",
244252
},
245-
{ text: "对话页面", link: "/zh/user-guide/chat-interface" },
246-
{ text: "记忆配置", link: "/zh/user-guide/memory" },
253+
{ text: "模型管理", link: "/zh/user-guide/model-management" },
254+
{ text: "记忆管理", link: "/zh/user-guide/memory-management" },
255+
{ text: "用户管理", link: "/zh/user-guide/user-management" },
247256
{
248257
text: "本地工具",
249258
items: [

doc/docs/en/deployment/upgrade-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,6 @@ Run the SQL scripts shipped with each release to keep your schema up to date.
134134
After deployment:
135135
136136
1. Open `http://localhost:3000` in your browser.
137-
2. Review the [User Guide](https://doc.nexent.tech/en/user-guide/) to validate agent functionality.
137+
2. Review the [User Guide](https://doc.nexent.tech/en/user-guide/home-page) to validate agent functionality.
138138
139139

doc/docs/en/getting-started/development-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ For detailed build instructions, see [Docker Build Guide](../deployment/docker-b
210210
### Documentation Resources
211211
- [Installation Guide](./installation.md) - Environment setup and deployment
212212
- [FAQ](./faq) - Frequently asked questions
213-
- [User Guide](../user-guide/) - Nexent user guide
213+
- [User Guide](../user-guide/home-page) - Nexent user guide
214214

215215
### Community Support
216216
- [Discord Community](https://discord.gg/tb5H3S3wyv) - Real-time communication and support

doc/docs/en/getting-started/faq.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,44 @@
11
# Nexent FAQ
22

3-
This FAQ addresses common questions and issues you might encounter while installing and using Nexent. For the basic installation steps, please refer to the [Installation & Development](./installation). For basic using instructions, please refer to the [User Guide](../user-guide/).
3+
This FAQ addresses common questions and issues you might encounter while installing and using Nexent. For the basic installation steps, please refer to the [Installation & Development](./installation). For basic using instructions, please refer to the [User Guide](../user-guide/home-page).
44

55
## 🚫 Common Errors & Operations
66

77
### 🌐 Network Connection Issues
8+
89
- **Q: How can a Docker container access models deployed on the host machine (e.g., Ollama)?**
910
- A: Since `localhost` inside the container refers to the container itself, use one of these methods to connect to host services:
1011

11-
**Option 1: Use Docker's special DNS name `host.docker.internal`**
12-
Supported environments: Mac/Windows and newer Docker Desktop versions (Linux version also supported)
12+
**Option 1: Use Docker's special DNS name `host.docker.internal`**
13+
14+
Supported environments: Mac/Windows and newer Docker Desktop versions (Linux version also supported)
15+
1316
```bash
1417
http://host.docker.internal:11434/v1
1518
```
1619

1720
**Option 2: Use host machine's actual IP (ensure firewall allows access)**
21+
1822
```bash
1923
http://[HOST_IP]:11434/v1
2024
```
2125
22-
**Option 3: Modify Docker Compose configuration**
26+
**Option 3: Modify Docker Compose configuration**
27+
2328
Add to your docker-compose.yaml file:
29+
2430
```yaml
2531
extra_hosts:
2632
- "host.docker.internal:host-gateway"
2733
```
2834
2935
### 🔌 Port Conflicts
36+
3037
- **Q: Port 3000 is already in use. How can I change it?**
3138
- A: You can modify the port in the Docker Compose configuration file.
3239
3340
### 📦 Container Issues
41+
3442
- **Q: How do I check container logs?**
3543
- A: Use `docker logs <container_name>` to view logs for specific containers.
3644
@@ -44,11 +52,23 @@ This FAQ addresses common questions and issues you might encounter while install
4452
2. **Valid API key**: Verify your API key has proper permissions
4553
3. **Model name**: Confirm the model identifier is correct
4654
4. **Network access**: Ensure your deployment can reach the provider's servers
47-
48-
For model setup instruction, see [Model Configuration](../user-guide/model-configuration) in User Guide.
55+
56+
For model setup instruction, see [Model Management](../user-guide/model-management) in User Guide.
57+
58+
- **Q: Multi-turn chats fail when using the official DeepSeek API. How can I resolve this?**
59+
- A: The official DeepSeek API only accepts text payloads, but Nexent sends multimodal payloads, so multi-turn calls are rejected. Use a provider such as SiliconFlow that exposes DeepSeek models with multimodal compatibility. Our requests look like:
60+
```python
61+
{ "role":"user", "content":[ { "type":"text", "text":"prompt" } ] }
62+
```
63+
whereas DeepSeek expects:
64+
```python
65+
{ "role":"user", "content":"prompt" }
66+
```
4967
5068
## 💡 Need Help
5169
5270
If your question isn't answered here:
71+
5372
- Join our [Discord community](https://discord.gg/tb5H3S3wyv) for real-time support
54-
- Check our [GitHub Issues](https://github.com/ModelEngine-Group/nexent/issues) for similar problems
73+
- Check our [GitHub Issues](https://github.com/ModelEngine-Group/nexent/issues) for similar problems
74+
- Open a thread in [GitHub Discussions](https://github.com/ModelEngine-Group/nexent/discussions).

doc/docs/en/getting-started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ After executing this command, the system will provide two different versions for
4848

4949
When deployment completes successfully:
5050
1. Open **http://localhost:3000** in your browser
51-
2. Refer to the [User Guide](../user-guide/) to develop agents
51+
2. Refer to the [User Guide](../user-guide/home-page) to develop agents
5252

5353

5454
## 🏗️ Service Architecture

doc/docs/en/user-guide/agent-configuration.md renamed to doc/docs/en/user-guide/agent-development.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Agent Configuration
1+
# Agent Development
22

3-
In the Agent Configuration module, you can create, configure, and manage agents. Agents are the core feature of Nexent—they can understand your needs and perform corresponding tasks.
3+
In the Agent Development page, you can create, configure, and manage agents. Agents are the core feature of Nexent—they can understand your needs and perform corresponding tasks.
44

55
## 🛠️ Agent Management
66

@@ -9,6 +9,7 @@ In the Agent Configuration module, you can create, configure, and manage agents.
99
On the Agent Management tab, click "Create Agent" to create a new blank agent. Click "Exit Create" to leave creation mode.
1010

1111
If you have an existing agent configuration, you can also import it:
12+
1213
1. Click "Import Agent"
1314
2. In the popup, select the agent configuration file (JSON format)
1415
3. Click "Open"; the system will validate the file format and content, and display the imported agent information
@@ -49,6 +50,8 @@ Agents can use various tools to complete tasks, such as knowledge base search, e
4950
<img src="./assets/agent/set-tool.png" style="width: 50%; height: auto;" />
5051
</div>
5152

53+
> 📚 Want to learn about all the built-in local tools in Nexent? Please see [Local Tools Overview](./local-tools/index.md).
54+
5255
### Add MCP Tools
5356

5457
Nexent allows you to quickly use third-party MCP tools to enrich agent capabilities.
@@ -61,7 +64,7 @@ Nexent allows you to quickly use third-party MCP tools to enrich agent capabilit
6164
<img src="./assets/agent/mcp.png" style="width: 80%; height: auto;" />
6265
</div>
6366

64-
Many third-party services such as ModelScope provide MCP services, which you can quickly integrate and use.
67+
Many third-party services such as [ModelScope](https://www.modelscope.cn/mcp) provide MCP services, which you can quickly integrate and use.
6568

6669
### Custom Tools
6770

@@ -70,15 +73,15 @@ You can refer to the following guides to develop your own tools and integrate th
7073
- [MCP Tool Development](../backend/tools/mcp)
7174
- [SDK Tool Documentation](../sdk/core/tools)
7275

73-
## 📝 Describe Business Logic
76+
## 📝 Describe the Agent’s Logic
7477

75-
### Describe How should this Agent Work
78+
### Describe How the Agent Should Work
7679

77-
Based on the selected collaborative agents and tools, you can now use concise language to describe how you want this agent to work. Nexent will automatically generate the agent’s name, description, and prompt suggestions based on your configuration and description.
80+
Once the collaborators and tools are ready, describe—in plain languagehow you expect the agent to behave. Nexent uses this description plus your configuration to auto-generate the agent name, description, and prompts.
7881

79-
1. In the "Describe should this agent work" editor, enter a brief description
80-
2. Click "Generate"; Nexent will generate detailed agent content for you
81-
3. You can further edit the generated content for fine-tuning
82+
1. Enter the description under **Describe how this agent should work**
83+
2. Click **Generate Agent** and wait for the detailed content
84+
3. Review the generated role prompt, constraints, examples, and tweak anything you want
8285

8386
<div style="display: flex; justify-content: left;">
8487
<img src="./assets/agent/generate-agent.png" style="width: 50%; height: auto;" />
@@ -94,14 +97,16 @@ After completing the initial agent configuration, you can debug the agent and op
9497

9598
### Manage Agents
9699

97-
- **Save:** After successful debugging, click the "Save" button in the lower right corner to save the agent. The agent will then be available for selection in the chat page.
98-
- **Export:** Export the successfully debugged agent configuration as a JSON file. When creating an agent, you can use this JSON file to create a copy via import.
99-
- **Delete:** Delete the agent (use with caution)
100+
- **Save:** After you finish debugging, click **Save** in the lower-right corner so the agent becomes available in Start Chat.
101+
- **Export:** Download a JSON file of any agent you like, then re-import it later to create copies.
102+
- **Delete:** Remove an agent you no longer need (this cannot be undone).
100103

101104
## 🚀 Next Steps
102105

103-
After completing agent configuration, you can click "Complete Setup" to proceed to:
106+
After shipping an agent you can:
104107

105-
1. **[Chat Interface](./chat-interface)** – Interact with your agent
108+
1. Manage every build inside **[Agent Space](./agent-space)**.
109+
2. Start working with your agent on the **[Start Chat](./start-chat)** page.
110+
3. Configure **[Memory Management](./memory-management)** to give agents persistent memory.
106111

107-
If you encounter any issues during agent configuration, please refer to our **[FAQ](../getting-started/faq)** or join our [Discord community](https://discord.gg/tb5H3S3wyv) for support.
112+
Need help? Check the **[FAQ](../getting-started/faq)** or open a thread in [GitHub Discussions](https://github.com/ModelEngine-Group/nexent/discussions).
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Agent Market
2+
3+
Agent Market is an upcoming Nexent module that will provide a curated catalog of ready-to-use agents.
4+
5+
## 🎯 Coming Features
6+
7+
Agent Market will let you:
8+
9+
- **Browse agents** – Explore featured and community-built agents.
10+
- **Install instantly** – Add high-quality agents to your workspace with one click.
11+
- **Share your work** – Publish the agents you build.
12+
- **Rate & give feedback** – Help the community discover great agents.
13+
14+
## ⏳ Stay Tuned
15+
16+
Agent Market is currently under development. We’re building an ecosystem where you can:
17+
18+
- Quickly access verified agents.
19+
- Share your creations with the community.
20+
- Discover new use cases and inspiration.
21+
22+
## 📢 Follow Updates
23+
24+
Want to know when Agent Market launches?
25+
26+
- Join the [Discord community](https://discord.gg/tb5H3S3wyv) for announcements.
27+
- Track project updates in the repository.
28+
29+
## 🚀 Related Features
30+
31+
While Agent Market is being built, you can:
32+
33+
1. Manage your agents in **[Agent Space](./agent-space)**.
34+
2. Create new agents in **[Agent Development](./agent-development)**.
35+
3. Test agents in **[Start Chat](./start-chat)**.
36+
37+
Need help? Check the **[FAQ](../getting-started/faq)** or open a thread in [GitHub Discussions](https://github.com/ModelEngine-Group/nexent/discussions).
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Agent Space
2+
3+
Agent Space is the central dashboard for every agent you have built. View agents in card form, inspect their configurations, delete or export them, and jump straight into chats.
4+
5+
## 📦 Agent Cards
6+
7+
Each agent appears as a card showing:
8+
9+
- **Icon** – The agent’s avatar.
10+
- **Name** – The display name.
11+
- **Description** – A quick summary of what it does.
12+
- **Status** – Whether the agent is available.
13+
- **Actions** – Shortcuts for editing, exporting, deleting, and more.
14+
15+
## 🔧 Manage Agents
16+
17+
### View Agent Details
18+
19+
Click a card to open its details:
20+
21+
- **Basic info:** ID, name, description, and status.
22+
- **Model configuration:** Model name, max tokens, business logic model, etc.
23+
- **Prompts:** Role, constraints, examples, and the original description.
24+
- **Tools:** Every tool the agent can use.
25+
- **Sub-agents:** Any collaborative agents that are configured.
26+
27+
### Edit an Agent
28+
29+
1. Click **Edit** on the card.
30+
2. You’ll be taken to the Agent Development page.
31+
3. Adjust the settings and save—updates sync back to Agent Space automatically.
32+
33+
### Delete an Agent
34+
35+
1. Click **Delete** on the card.
36+
2. Confirm the deletion (this cannot be undone).
37+
38+
> ⚠️ **Note:** Deleting an agent permanently removes it. Export a backup first if you might need it later.
39+
40+
### Export an Agent
41+
42+
1. Click **Export** on the card.
43+
2. Nexent downloads a JSON configuration file you can import later.
44+
45+
### View Relationships
46+
47+
1. Click **View Relationships** to see how the agent interacts with tools and other agents.
48+
49+
### Jump to Chat
50+
51+
1. Click **Chat** to open Start Chat with the agent already selected.
52+
53+
## 🚀 Next Steps
54+
55+
Once you finish reviewing agents you can:
56+
57+
1. Talk to them in **[Start Chat](./start-chat)**.
58+
2. Continue iterating in **[Agent Development](./agent-development)**.
59+
3. Enhance retention with **[Memory Management](./memory-management)**.
60+
61+
Need help? Check the **[FAQ](../getting-started/faq)** or open a thread in [GitHub Discussions](https://github.com/ModelEngine-Group/nexent/discussions).

0 commit comments

Comments
 (0)