Skip to content

Commit c0a43d1

Browse files
authored
📝 Update docs to fit feature changes in v1.7.4
2 parents 2c4f87b + 6240aa6 commit c0a43d1

26 files changed

+241
-538
lines changed

doc/docs/.vitepress/config.mts

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,15 @@ export default defineConfig({
3535
text: "Getting Started",
3636
items: [
3737
{ text: "Overview", link: "/en/getting-started/overview" },
38-
{
39-
text: "Installation & Setup",
40-
link: "/en/getting-started/installation",
41-
},
42-
{
43-
text: "Model Providers",
44-
link: "/en/getting-started/model-providers",
45-
},
4638
{ text: "Key Features", link: "/en/getting-started/features" },
4739
{
4840
text: "Software Architecture",
4941
link: "/en/getting-started/software-architecture",
5042
},
43+
{
44+
text: "Installation & Deployment",
45+
link: "/en/getting-started/installation",
46+
},
5147
{
5248
text: "Development Guide",
5349
link: "/en/getting-started/development-guide",
@@ -217,16 +213,12 @@ export default defineConfig({
217213
text: "快速开始",
218214
items: [
219215
{ text: "项目概览", link: "/zh/getting-started/overview" },
220-
{ text: "安装与配置", link: "/zh/getting-started/installation" },
221-
{
222-
text: "模型提供商",
223-
link: "/zh/getting-started/model-providers",
224-
},
225216
{ text: "核心特性", link: "/zh/getting-started/features" },
226217
{
227218
text: "软件架构",
228219
link: "/zh/getting-started/software-architecture",
229220
},
221+
{ text: "安装部署", link: "/zh/getting-started/installation" },
230222
{
231223
text: "开发指南",
232224
link: "/zh/getting-started/development-guide",

doc/docs/en/docs-development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ pnpm vitepress dev docs
3333

3434
After successfully start, visit:
3535

36-
- `http://localhost:5173/doc`
36+
- `http://localhost:5173/doc/`
3737

3838
## ✍️ Add or Edit Docs
3939
- Put Chinese docs under `doc/docs/zh` and English docs under `doc/docs/en`.

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,10 +201,9 @@ For detailed build instructions, see [Docker Build Guide](../deployment/docker-b
201201

202202
### Documentation Resources
203203
- [Installation Guide](./installation.md) - Environment setup and deployment
204-
- [Model Providers](./model-providers.md) - Model configuration and API acquisition
205204
- [FAQ](./faq) - Frequently asked questions
205+
- [User Guide](../user-guide/) - Nexent user guide
206206

207207
### Community Support
208208
- [Discord Community](https://discord.gg/tb5H3S3wyv) - Real-time communication and support
209-
- [GitHub Issues](https://github.com/ModelEngine-Group/nexent/issues) - Issue reporting and feature requests
210-
- [Contributing Guide](../contributing.md) - Participate in project development
209+
- [GitHub Issues](https://github.com/ModelEngine-Group/nexent/issues) - Issue reporting and feature requests

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

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
# Nexent FAQ
22

3-
This FAQ addresses common questions and issues you might encounter while installing and deploying Nexent. For the basic installation steps, please refer to the [Quick Start Guide](./overview#quick-start) in our documentation.
4-
5-
## 🚀 Installation & Setup
6-
7-
For model provider setup and API key acquisition, see our detailed **[Model Providers Guide](./model-providers)**.
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/).
84

95
## 🚫 Common Errors & Operations
106

@@ -49,19 +45,10 @@ For model provider setup and API key acquisition, see our detailed **[Model Prov
4945
3. **Model name**: Confirm the model identifier is correct
5046
4. **Network access**: Ensure your deployment can reach the provider's servers
5147

52-
For specific provider setup, see our [Model Providers Guide](./model-providers).
53-
54-
### 📧 Email Tools Configuration
55-
- **Q: How can I enable and configure email tools?**
56-
- A: Our team has pre-implemented email tools based on IMAP and SMTP. To enable them:
57-
1. Configure email parameters in `.env` file
58-
2. Uncomment the email tool imports and registrations in `agent_utils.py`
59-
3. Switch to the email-enabled system prompt by using `code_agent_with_email.yaml`
60-
4. Restart the MCP service to apply changes
48+
For model setup instruction, see [Model Configuration](../user-guide/model-configuration) in User Guide.
6149

6250
## 💡 Need Help
6351

6452
If your question isn't answered here:
6553
- Join our [Discord community](https://discord.gg/tb5H3S3wyv) for real-time support
66-
- Check our [GitHub Issues](https://github.com/ModelEngine-Group/nexent/issues) for similar problems
67-
- Refer to our [Contribution Guide](../contributing) for more detailed information
54+
- Check our [GitHub Issues](https://github.com/ModelEngine-Group/nexent/issues) for similar problems

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

Lines changed: 14 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Installation & Setup
1+
# Installation & Deployment
22

33
## 🎯 Prerequisites
44

@@ -19,67 +19,41 @@ cd nexent/docker
1919
cp .env.example .env # Configure environment variables
2020
```
2121

22+
> **💡 Tip**: If there are no special requirements, you can directly use `.env.example` for deployment without making any changes. If you need to configure voice models (STT/TTS), you will need to set the relevant parameters in `.env`. We will work on making this configuration available through the frontend soon—stay tuned.
23+
2224
### 2. Deployment Options
2325

24-
The deployment script offers multiple modes:
26+
Run the following command to start deployment:
2527

2628
```bash
2729
bash deploy.sh
2830
```
2931

30-
**Available deployment modes:**
32+
After executing this command, the system will provide two different versions for you to choose from:
33+
34+
**Version Selection:**
35+
- **Speed version (Lightweight & Fast Deployment, Default)**: Quick startup of core features, suitable for individual users and small teams
36+
- **Full version (Complete Feature Edition)**: Provides enterprise-level tenant management and resource isolation features, but takes longer to install, suitable for enterprise users
37+
38+
**Deployment Modes:**
3139
- **Development mode (default)**: Exposes all service ports for debugging
3240
- **Infrastructure mode**: Only starts infrastructure services
3341
- **Production mode**: Only exposes port 3000 for security
34-
- **Beta mode**: Uses development branch images
3542

36-
**Optional components:**
43+
**Optional Components:**
3744
- **Terminal Tool**: Enables openssh-server for AI agent shell command execution
3845
- **Regional optimization**: Mainland China users can use optimized image sources
3946

4047
### 3. Access Your Installation
4148

4249
When deployment completes successfully:
4350
1. Open **http://localhost:3000** in your browser
44-
2. Follow the setup wizard for initial configuration
45-
3. Configure your model providers (see [Model Providers Guide](./model-providers))
46-
47-
## 🤖 Model Configuration
48-
49-
Nexent supports all **OpenAI-compatible models**, including:
50-
- **Large Language Models (LLM)**: Any OpenAI-compatible API provider
51-
- **Multimodal Vision Models**: Text + image processing capabilities
52-
- **Embedding Models**: All OpenAI-compatible embedding services
53-
- **Text-to-Speech & Speech-to-Text**: Multiple provider support
54-
- **Search Integration**: Web search and semantic retrieval
55-
56-
### Quick Provider Setup
51+
2. Refer to the [User Guide](../user-guide/) to develop agents
5752

58-
For detailed setup instructions and API key acquisition, see our **[Model Providers Guide](./model-providers)**.
59-
60-
**Recommended for Quick Start**:
61-
- **LLM**: [Silicon Flow](https://siliconflow.cn/) (Free tier available)
62-
- **Embedding**: [Jina AI](https://jina.ai/) (Free tier available)
63-
- **Search**: [EXA](https://exa.ai/) (Free tier available)
64-
65-
### Configuration Methods
66-
67-
**Method 1: Web Interface**
68-
1. Access model configuration at `http://localhost:3000`
69-
2. Add provider details: Base URL, API Key, Model Name
70-
71-
**Method 2: Environment Variables**
72-
Add to your `.env` file:
73-
```bash
74-
LLM_BASE_URL=https://api.siliconflow.cn/v1
75-
LLM_API_KEY=your_api_key
76-
EMBEDDING_API_KEY=your_jina_key
77-
EXA_API_KEY=your_exa_key
78-
```
7953

8054
## 🏗️ Service Architecture
8155

82-
The deployment includes the following components:
56+
Nexent uses a microservices architecture with the following core services:
8357

8458
**Core Services:**
8559
- `nexent`: Backend service (port 5010)

doc/docs/en/getting-started/model-providers.md

Lines changed: 0 additions & 151 deletions
This file was deleted.

0 commit comments

Comments
 (0)