Mintplex-Labs/anythingllm-docs

Documentation of AnythingLLM by Mintplex Labs Inc.

解决的问题

此仓库托管 AnythingLLM 产品的文档。它为用户和开发者提供了一个结构化的地方,以查找设置说明、功能解释、API 参考和其他指导,因此他们不必在代码或支持渠道中搜寻。

工作原理

文档构建为 NextJS 站点。pages/ 文件夹包含按主题(agent、api、changelog、cloud、features、installation、setup)组织的 MDX 文件。静态资源(如图像和图标)位于 public/ 和 components/ 中。要在本地处理文档,请克隆仓库,运行 yarn 安装依赖项,然后运行 yarn dev 启动开发服务器。

适用对象

任何使用或贡献于 AnythingLLM 产品的人——寻找指南的最终用户、检查 API 细节的开发者,以及希望改进文档本身的贡献者。

亮点

  • 使用 NextJS 构建(最近迁移到它)
  • 内容部分清晰分离:agent、API、changelog、cloud、features、installation、setup
  • 简单的本地开发:克隆、yarn、yarn dev
  • 在 MIT 许可下开源,并通过拉取请求提供清晰的贡献工作流

相关

  • 项目
  • 项目
  • 项目
  • 项目