Skip to content

Commit 3d6a2c6

Browse files
committed
📝 Update more documentations and delete duplicated ones
1 parent 8e5dfa2 commit 3d6a2c6

Some content is hidden

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

44 files changed

+1780
-5197
lines changed

AUTHORS

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,21 @@
11
Nexent Team:
2+
3+
Team Manager / Product Manager:
24
Shuangrui Chen @Phinease
5+
6+
Senior System Engineer:
37
Simeng Bian @Simeng Bian
4-
Tao Liu @ liutao12138
8+
Tao Liu @liutao12138
9+
10+
Development Group Leader:
511
Jingyuan Li @ljy65535
12+
13+
Developer:
14+
Yichen Xia @Jasonxia007
615
Mingchen Wan @WMC001
7-
Yichen Xia @ Jasonxia007
8-
Yu Lin @ linsensen222
16+
Yu Lin @linsensen222
17+
Wenqi Bai @Bavichi
18+
Feiyang Xiang @feixiangkong
19+
20+
Operations Manager:
21+
Chenxue Jia @Davina-jcx

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Thank you for considering contributing to Nexent! From code to docs to sharing your experience, every bit helps make Nexent better for everyone. It also helps us if you share Nexent with others, or simply ⭐️ the repo. Thanks a million! 💛 Let's build something amazing together! 🎉
77

8-
In terms of licensing, please take a minute to read our short [License and Contributor Agreement](https://github.com/ModelEngine-Group/nexent/blob/main/LICENSE). The community also adheres to the [code of conduct](https://github.com/ModelEngine-Group/nexent/blob/main/CODE_OF_CONDUCT.md).
8+
In terms of licensing, please take a minute to read our short [License and Contributor Agreement](https://modelengine-group.github.io/nexent/en/license). The community also adheres to the [code of conduct](https://modelengine-group.github.io/nexent/en/code-of-conduct).
99

1010
## 🤔 How You Can Contribute
1111

@@ -86,7 +86,7 @@ git checkout -b your-branch-name
8686
```
8787

8888
### Step 4 Make Your Changes
89-
🧙‍♂️ Code like a wizard! Follow our [Development Guide](./DEVELOPPER_NOTE.md) for setup instructions and coding standards. Ensure your changes are well-tested and documented.
89+
🧙‍♂️ Code like a wizard! Follow our [Development Guide](https://modelengine-group.github.io/nexent/en/getting-started/development-guide) for setup instructions and coding standards. Ensure your changes are well-tested and documented.
9090

9191
### Step 5 Commit Your Changes
9292
📝 Commit with a clear and concise message following our commit message guidelines:

CONTRIBUTING_CN.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
感谢您考虑为 Nexent 贡献力量!无论是代码、文档还是经验分享,您的每一份付出都能让 Nexent 变得更好。如果您愿意向他人推荐 Nexent 或在仓库点个 ⭐️,我们也非常感激。万分感谢!💛 让我们一起打造非凡之作!🎉
77

8-
关于许可证,请花一分钟阅读我们简短的[许可和贡献者协议](https://github.com/ModelEngine-Group/nexent/blob/main/LICENSE)。同时也请遵循[社区行为准则](https://github.com/ModelEngine-Group/nexent/blob/main/CODE_OF_CONDUCT.md)
8+
关于许可证,请花一分钟阅读我们简短的[许可和贡献者协议](https://modelengine-group.github.io/nexent/zh/license)。同时也请遵循[社区行为准则](https://modelengine-group.github.io/nexent/zh/code-of-conduct)
99

1010
## 🤔 如何贡献
1111

@@ -89,7 +89,7 @@ git checkout -b 您的分支名
8989
```
9090

9191
### 第四步:进行更改
92-
🧙‍♂️ 像魔法师一样编码!遵循我们的 [开发指南](./DEVELOPPER_NOTE_CN.md) 获取设置说明和编码标准。确保您的更改经过充分测试并有文档记录。
92+
🧙‍♂️ 像魔法师一样编码!遵循我们的 [开发指南](https://modelengine-group.github.io/nexent/zh/getting-started/development-guide) 获取设置说明和编码标准。确保您的更改经过充分测试并有文档记录。
9393

9494
### 第五步:提交更改
9595
📝 按照我们的提交消息规范,提交清晰简洁的消息(建议采用英文,让更多人理解你):

DEVELOPPER_NOTE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,6 @@ docker builder prune -f && docker system prune -f
338338
5. System prompts need thorough testing
339339

340340
### Getting Help 💬
341-
- Check the [FAQ](FAQ.md)
341+
- Check Our [Documentation](https://modelengine-group.github.io/nexent/en/getting-started/overview)
342342
- Join our [Discord community](https://discord.gg/tb5H3S3wyv)
343343
- Submit [GitHub Issues](https://github.com/ModelEngine-Group/nexent/issues)

DEVELOPPER_NOTE_CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,6 +344,6 @@ docker builder prune -f && docker system prune -f
344344
5. 系统提示词需充分测试
345345

346346
### 获取帮助 💬
347-
- 查看 [常见问题](FAQ_CN.md)
347+
- 查看 [我们的文档](https://modelengine-group.github.io/nexent/zh/getting-started/overview)
348348
- 加入 [Discord 社区](https://discord.gg/tb5H3S3wyv)
349349
- 提交 [GitHub Issues](https://github.com/ModelEngine-Group/nexent/issues)

FAQ.md

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

FAQ_CN.md

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

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ We have released **Nexent v1**, and the platform is now relatively stable. Howev
2626

2727
> *Rome wasn't built in a day.*
2828
29-
If our vision speaks to you, jump in via the **[Contribution Guide](CONTRIBUTING.md)** and shape Nexent with us.
29+
If our vision speaks to you, jump in via the **[Contribution Guide](https://modelengine-group.github.io/nexent/en/contributing)** and shape Nexent with us.
3030

3131
Early contributors won't go unnoticed: from special badges and swag to other tangible rewards, we're committed to thanking the pioneers who help bring Nexent to life.
3232

@@ -74,21 +74,21 @@ The following configurations need to be added to your `.env` file (we'll make th
7474
- TTS and STT related configurations
7575
- EXA search API Key
7676

77-
> ℹ️ Due to core features development, currently, we only support Jina Embedding model. Support for other models will be added in future releases. For Jina API key setup, please refer to our [FAQ](FAQ.md).
77+
> ℹ️ Due to core features development, currently, we only support Jina Embedding model. Support for other models will be added in future releases. For Jina API key setup, please refer to our [FAQ](https://modelengine-group.github.io/nexent/en/faq).
7878
7979
### 4. ❓ Need help?
8080

81-
- Browse the [FAQ](FAQ.md) for common install issues.
81+
- Browse the [FAQ](https://modelengine-group.github.io/nexent/en/faq) for common install issues.
8282
- Drop questions in our [Discord community](https://discord.gg/tb5H3S3wyv).
8383
- File bugs or feature ideas in [GitHub Issues](https://github.com/ModelEngine-Group/nexent/issues).
8484

8585
### 5. 🔧 Hack on Nexent
8686

87-
Want to build from source or add new features? Check the [Contribution Guide](CONTRIBUTING.md) for step-by-step instructions.
87+
Want to build from source or add new features? Check the [Contribution Guide](https://modelengine-group.github.io/nexent/en/contributing) for step-by-step instructions.
8888

8989
### 6. 🛠️ Build from Source
9090

91-
Prefer to run Nexent from source code? Follow our [Developer Guide](DEVELOPPER_NOTE.md) for detailed setup instructions and customization options.
91+
Prefer to run Nexent from source code? Follow our [Developer Guide](https://modelengine-group.github.io/nexent/en/getting-started/development-guide) for detailed setup instructions and customization options.
9292

9393
## 🌱 MCP Tool Ecosystem
9494

README_CN.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ https://github.com/user-attachments/assets/b844e05d-5277-4509-9463-1c5b3516f11e
2626

2727
> *Rome wasn't built in a day.*
2828
29-
如果我们的愿景与您产生共鸣,请通过 **[贡献指南](CONTRIBUTING_CN.md)** 加入我们,共同塑造 Nexent。
29+
如果我们的愿景与您产生共鸣,请通过 **[贡献指南](https://modelengine-group.github.io/nexent/zh/contributing)** 加入我们,共同塑造 Nexent。
3030

3131
早期贡献者不会被忽视:从特殊徽章和纪念品到其他实质性奖励,我们致力于感谢那些帮助 Nexent 诞生的先驱者。
3232

@@ -74,21 +74,21 @@ bash deploy.sh
7474
- TTS 与 STT 相关配置
7575
- EXA 搜索 API Key
7676

77-
> ℹ️ 由于开发紧张,目前我们仅支持 Jina Embedding 模型。其他模型的支持将在未来版本中添加。有关 Jina API 密钥获取,请参阅我们的[常见问题](FAQ_CN.md)
77+
> ℹ️ 由于开发紧张,目前我们仅支持 Jina Embedding 模型。其他模型的支持将在未来版本中添加。有关 Jina API 密钥获取,请参阅我们的[常见问题](https://modelengine-group.github.io/nexent/zh/faq)
7878
7979
### 4. ❓ 需要帮助?
8080

81-
- 浏览 [常见问题](FAQ_CN.md) 了解常见安装问题。
81+
- 浏览 [常见问题](https://modelengine-group.github.io/nexent/zh/faq) 了解常见安装问题。
8282
- 在我们的 [Discord 社区](https://discord.gg/tb5H3S3wyv) 中提问。
8383
-[GitHub Issues](https://github.com/ModelEngine-Group/nexent/issues) 中提交错误报告或功能建议。
8484

8585
### 5. 🔧 开发 Nexent
8686

87-
想要从源代码构建或添加新功能?查看 [贡献指南](CONTRIBUTING_CN.md) 获取分步说明。
87+
想要从源代码构建或添加新功能?查看 [贡献指南](https://modelengine-group.github.io/nexent/zh/contributing) 获取分步说明。
8888

8989
### 6. 🛠️ 从源码构建
9090

91-
想要从源码运行 Nexent?查看我们的[开发者指南](DEVELOPPER_NOTE_CN.md)获取详细的设置说明和自定义选项。
91+
想要从源码运行 Nexent?查看我们的[开发者指南](https://modelengine-group.github.io/nexent/zh/getting-started/development-guide)获取详细的设置说明和自定义选项。
9292

9393
## 🌱 MCP 工具生态
9494

0 commit comments

Comments
 (0)