Skip to content

Commit a15005d

Browse files
committed
📝 Update more documentations (phase 4)
1 parent 3aac992 commit a15005d

File tree

11 files changed

+725
-743
lines changed

11 files changed

+725
-743
lines changed

doc/docs/.vitepress/config.mts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,14 @@ export default defineConfig({
3232
{ text: 'Key Features', link: '/en/getting-started/features' },
3333
{ text: 'Software Architecture', link: '/en/getting-started/software-architecture' },
3434
{ text: 'Development Guide', link: '/en/getting-started/development-guide' },
35-
{ text: 'FAQ', link: '/en/faq' }
35+
{ text: 'FAQ', link: '/en/getting-started/faq' }
3636
]
3737
},
3838
{
3939
text: 'SDK Documentation',
4040
items: [
4141
{ text: 'SDK Overview', link: '/en/sdk/overview' },
42+
{ text: 'Basic Usage', link: '/en/sdk/basic-usage' },
4243
{
4344
text: 'Core Modules',
4445
items: [
@@ -134,13 +135,14 @@ export default defineConfig({
134135
{ text: '核心特性', link: '/zh/getting-started/features' },
135136
{ text: '软件架构', link: '/zh/getting-started/software-architecture' },
136137
{ text: '开发指南', link: '/zh/getting-started/development-guide' },
137-
{ text: '常见问题', link: '/zh/faq' }
138+
{ text: '常见问题', link: '/zh/getting-started/faq' }
138139
]
139140
},
140141
{
141142
text: 'SDK 文档',
142143
items: [
143144
{ text: 'SDK 概览', link: '/zh/sdk/overview' },
145+
{ text: '基本使用', link: '/zh/sdk/basic-usage' },
144146
{
145147
text: '核心模块',
146148
items: [

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

Lines changed: 36 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# Nexent Development Guide
22

3-
## Project Overview
3+
This guide provides comprehensive information for developers to understand and contribute to the Nexent project, covering architecture, technology stack, development environment setup, and best practices.
44

5-
Nexent is an AI agent-based intelligent conversation system with a frontend-backend separation architecture, supporting enterprise-level features like multi-tenancy, multi-language, and streaming responses.
6-
7-
## Overall Architecture
5+
## 🏗️ Overall Architecture
86

97
```
108
nexent/
@@ -17,29 +15,7 @@ nexent/
1715
└── assets/ # Static resources
1816
```
1917

20-
## Architecture Module Overview
21-
22-
### 🎨 Frontend Development
23-
- **Tech Stack**: Next.js 14 + TypeScript + React + Tailwind CSS
24-
- **Core Features**: User interface, real-time chat, configuration management, internationalization
25-
- **Details**: See [Frontend Overview](../frontend/overview.md)
26-
27-
### 🔧 Backend Development
28-
- **Tech Stack**: FastAPI + Python 3.10+ + PostgreSQL + Redis + Elasticsearch
29-
- **Core Features**: API services, agent management, data processing, vector search
30-
- **Details**: See [Backend Overview](../backend/overview.md)
31-
32-
### 🤖 AI Agents
33-
- **Framework**: Enterprise agent framework based on smolagents
34-
- **Core Features**: Agent creation, tool integration, reasoning execution, multi-modal support
35-
- **Details**: See [Agent Overview](../agents/overview.md)
36-
37-
### 📦 SDK Development Kit
38-
- **Features**: Complete interfaces for AI agents, model calling, tool integration
39-
- **Modules**: Core agents, data processing, vector database
40-
- **Details**: See [SDK Overview](../sdk/overview.md)
41-
42-
## Technology Stack
18+
## 🛠️ Technology Stack
4319

4420
### Frontend Tech Stack
4521
- **Framework**: Next.js 14 (App Router)
@@ -64,59 +40,78 @@ nexent/
6440
- **Monitoring**: Built-in health checks
6541
- **Logging**: Structured logging
6642

67-
## Development Environment Setup 🚀
43+
## 🚀 Development Environment Setup
6844

69-
### 1. Environment Requirements
45+
### Environment Requirements
7046
- Python 3.10+
7147
- Node.js 18+
7248
- Docker & Docker Compose
7349
- uv (Python package manager)
7450

75-
### 2. Backend Setup
51+
### Backend Setup
7652
```bash
7753
cd backend
7854
uv sync && uv pip install -e ../sdk
7955
```
8056

81-
### 3. Frontend Setup
57+
### Frontend Setup
8258
```bash
8359
cd frontend
8460
npm install
8561
npm run dev
8662
```
8763

88-
### 4. Service Startup
64+
### Service Startup
8965
Nexent includes three core backend services that need to be started separately:
9066
```bash
9167
python backend/data_process_service.py # Data processing service
9268
python backend/main_service.py # Main service
9369
python backend/nexent_mcp_service.py # MCP service
9470
```
9571

96-
## Development Module Guide
72+
## 🔧 Development Module Guide
73+
74+
### 🎨 Frontend Development
75+
- **Tech Stack**: Next.js 14 + TypeScript + React + Tailwind CSS
76+
- **Core Features**: User interface, real-time chat, configuration management, internationalization
77+
- **Details**: See [Frontend Overview](../frontend/overview.md)
78+
79+
### 🔧 Backend Development
80+
- **Tech Stack**: FastAPI + Python 3.10+ + PostgreSQL + Redis + Elasticsearch
81+
- **Core Features**: API services, agent management, data processing, vector search
82+
- **Details**: See [Backend Overview](../backend/overview.md)
9783

98-
### Agent Development 🤖
84+
### 🤖 AI Agent Development
85+
- **Framework**: Enterprise agent framework based on smolagents
86+
- **Core Features**: Agent creation, tool integration, reasoning execution, multi-modal support
9987
- **Custom Agents**: See [Agent Overview](../agents/overview.md)
10088
- **System Prompts**: Located in `backend/prompts/`
10189
- **Implementation Steps**: Create instance → Configure tools → Set prompts → Test run
90+
- **Details**: See [Agent Overview](../agents/overview.md)
10291

103-
### Tool Development 🛠️
92+
### 🛠️ Tool Development
10493
- **MCP Tool System**: Based on Model Context Protocol
10594
- **Development Flow**: Implement logic → Register tool → Restart service
95+
- **Protocol Compliance**: Tool development must follow MCP protocol
10696
- **Detailed Specification**: See [Tool Development Guide](../sdk/core/tools.md)
10797

108-
### Data Processing 📊
98+
### 📦 SDK Development Kit
99+
- **Features**: Complete interfaces for AI agents, model calling, tool integration
100+
- **Modules**: Core agents, data processing, vector database
101+
- **Details**: See [SDK Overview](../sdk/overview.md)
102+
103+
### 📊 Data Processing
109104
- **File Processing**: Supports 20+ formats
110105
- **Chunking Strategies**: basic, by_title, none
111106
- **Streaming Processing**: Memory optimization for large files
112107
- **Details**: See [Data Processing Guide](../sdk/data-process.md)
113108

114-
## Build & Deployment 🏗️
109+
## 🏗️ Build & Deployment
115110

116111
### Docker Build
117112
For detailed build instructions, see [Docker Build Guide](../deployment/docker-build.md)
118113

119-
## Development Best Practices
114+
## 📋 Development Best Practices & Important Notes
120115

121116
### Code Quality
122117
1. **Test-Driven**: Write unit tests and integration tests
@@ -136,15 +131,13 @@ For detailed build instructions, see [Docker Build Guide](../deployment/docker-b
136131
3. **Sensitive Information**: Properly handle sensitive data like API keys
137132
4. **Security Updates**: Regular dependency and security updates
138133

139-
## Important Notes ⚠️
140-
134+
### Important Development Notes
141135
1. **Service Dependencies**: Ensure all services are started before testing
142136
2. **Code Changes**: Restart related services after code modifications
143137
3. **Development Mode**: Use debug mode in development environment
144-
4. **Protocol Compliance**: Tool development must follow MCP protocol
145-
5. **Prompt Testing**: System prompts need thorough testing
138+
4. **Prompt Testing**: System prompts need thorough testing
146139

147-
## Getting Help 💬
140+
## 💡 Getting Help
148141

149142
### Documentation Resources
150143
- [Installation Guide](./installation.md) - Environment setup and deployment
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
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](./getting-started/overview#quick-start) in our documentation.
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.
44

55
## 🚀 Installation & Setup
66

7-
For model provider setup and API key acquisition, see our detailed **[Model Providers Guide](./getting-started/model-providers)**.
7+
For model provider setup and API key acquisition, see our detailed **[Model Providers Guide](./model-providers)**.
88

99
## 🚫 Common Errors & Operations
1010

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

52-
For specific provider setup, see our [Model Providers Guide](./getting-started/model-providers).
52+
For specific provider setup, see our [Model Providers Guide](./model-providers).
5353

5454
### 📧 Email Tools Configuration
5555
- **Q: How can I enable and configure email tools?**
@@ -59,9 +59,9 @@ For model provider setup and API key acquisition, see our detailed **[Model Prov
5959
3. Switch to the email-enabled system prompt by using `code_agent_with_email.yaml`
6060
4. Restart the MCP service to apply changes
6161

62-
## ❓ Still Need Help?
62+
## 💡 Need Help
6363

6464
If your question isn't answered here:
6565
- Join our [Discord community](https://discord.gg/tb5H3S3wyv) for real-time support
6666
- 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
67+
- Refer to our [Contribution Guide](../contributing) for more detailed information

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

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,23 @@ Drop in or build Python plug-ins that follow the MCP spec; swap models, tools, a
4646

4747
## 🏗️ Architecture Benefits
4848

49-
- **Zero-Code Development**: Build sophisticated agents using natural language
50-
- **Scalable Processing**: Handle everything from single files to enterprise-scale batch operations
51-
- **Rich Integration**: Connect with multiple AI models, databases, and external services
52-
- **Extensible Design**: Add new capabilities through the MCP ecosystem
53-
- **Enterprise Ready**: Built for production environments with proper scaling and monitoring
49+
### ⚡ Distributed Processing Capabilities
50+
- **Asynchronous Architecture**: High-performance asynchronous processing based on asyncio
51+
- **Multi-threading Safety**: Thread-safe concurrent processing mechanisms
52+
- **Celery Integration**: Optimized for distributed task queues
53+
- **Batch Optimization**: Intelligent batch operations to reduce network overhead
54+
55+
### 🏢 Enterprise-grade Scalability
56+
- **Modular Design**: Loose-coupled module architecture for easy extension
57+
- **Plugin-based Tools**: Standardized tool interfaces for rapid integration
58+
- **Configuration Management**: Flexible configuration system supporting multi-environment deployment
59+
- **Monitoring Friendly**: Comprehensive logging and status monitoring
60+
61+
### 🚀 High-performance Optimization
62+
- **Connection Pooling**: Intelligent reuse of database and HTTP connections
63+
- **Memory Management**: Stream processing of large files and memory optimization
64+
- **Concurrency Control**: Intelligent concurrency limiting and load balancing
65+
- **Caching Strategy**: Multi-layer caching to improve response speed
5466

5567
For detailed information about Nexent's software architecture and technical advantages, see our **[Software Architecture](./software-architecture)** guide.
5668

0 commit comments

Comments
 (0)