nkuwiki 项目文档

导航

本文档集合旨在帮助用户和开发者理解、安装、配置、使用和参与 nkuwiki 项目。

用户与部署

• 安装指南: 如何在您的环境中安装 nkuwiki。
• 配置指南: 详细说明各项配置参数及其作用。
• 部署指南: 如何部署 nkuwiki 服务，包括单实例和多实例场景。

模块与功能

• 爬虫模块使用指南: 如何使用和开发 etl/crawler 模块。
• 问答服务指南: 关于问答服务的说明和使用。
• Redis 使用指南: 项目中 Redis 的使用场景和配置。
• 前端指南: 前端微信小程序的开发与构建。
• 数据库指南: 项目中 MySQL 和 Qdrant 数据库的使用说明。
• Docker 使用指南: 项目中 Docker 的使用说明。
• API 文档: 项目提供的 API 接口说明 (详细内容请参考该文档)。

开发与贡献

• 开发者指南: 面向开发者的综合指南，包含项目架构、模块介绍、开发规范等。

快速开始

• 新用户: 请从 安装指南 开始，然后参照 配置指南 和 部署指南。
• 开发者: 请首先阅读 开发者指南，并根据需要查阅特定模块的文档，如 爬虫模块使用指南。

贡献与反馈

如果您在阅读文档或使用项目过程中发现任何问题，或有改进建议，欢迎通过以下方式反馈：

1. 在项目的 GitHub 仓库提交 Issue。
2. 联系项目维护团队 (联系方式见项目根目录 README.md)。

感谢您的关注和贡献！