NekroNXT 文档
September 6, 2026 · View on GitHub
这里是 NekroNXT 的公开文档入口。第一次使用从快速开始进入;开发时按任务定位相关章节,已知局部问题可直接进入源码、测试或契约,不要求逐级全文预读。
开始使用
- 快速开始:从安装到第一次内置频道对话;
- 桌面版安装:macOS、Windows、Linux 安装包与稳定版/预览版;
- 服务端部署:一行启动容器,详细配置 Docker、Compose、远程访问与数据目录;
- 配置模型:模型供应商、API Key、连接测试和模型选择;
- 创建智能体:人设、模型、授权能力和内置频道;
- 连接频道:添加平台账号、发现频道、绑定和触发方式;可接入 QQ 官方机器人、OneBot V11或企业微信智能机器人;
- 使用扩展:动态运行、验证、保存和为智能体启用;
- 升级、备份与恢复:双通道、数据根和恢复原则;
- 常见问题与排障:安装、Host、模型、连接和扩展问题;
- 贡献者入口:源码开发、架构、测试和文档维护。
产品与设计
- 项目首页与英文摘要:公众定位、安装入口、真实截图和社区信息;
- 项目共识:产品定位、一期范围和核心对象;
- 产品形态与用户旅程:完整用户路径和页面关系;
- 界面交互模型:页面对象、操作前提和真实后果;
- 术语与文案规范:用户可见实体名称和文案语气;
- 桌面 UI 与动效规范:主题、布局、组件、动效和品牌使用;
- Glin UI 隔离实验:独立 worktree 中的视觉体系、性能边界和启动方式;
- 一期开发计划:当前状态与完成标准;
- 未来扩展方向:尚未启动的能力和兼容接缝。
- 交互原型说明:早期对象关系参考,不替代现行产品页面。
架构与协议
- 消息内容与投递协议:消息块、通信工具、Asset 和投递边界;
- 接线与 Server 宿主设计:Server、Web、HTTP、SSE 和静态入口;
- Decision 路由:跨包契约和实现决定;
- Apps 索引与 Packages 索引:代码所有者、消费者和包级命令。
工程与公开边界
- 开发与测试规范:提交、测试阶梯、产品旅程和视觉验收;
- 正式发布与更新日志规范:更新内容、用户审查门禁、版本校验、Tag 与在线发布;
- 文档公开边界:敏感信息、真实样本和发布前检查;
- 参考项目复用指南:引入外部机制时的证据与边界;
- 品牌资产与品牌使用规范:Logo、安装资源、角色和宣传素材;
- 贡献指南、支持说明、安全策略与社区行为准则:参与项目和反馈问题;
- NekroAI 组织主页资料:组织 Profile README 文案和素材映射;
- 仓库公开检查清单:许可证、历史审计、GitHub About、安全报告和 ruleset;
- 冻结历史:只用于追溯过程,不作为现行规范。
文档维护
现行契约描述当前事实,Decision 保存理由、状态和契约入口;职责与冲突处理见开发规范 §1。每份受维护公开文档从根 AGENTS.md 经本索引或专题索引可达;pnpm check:docs 检查链接、标题片段、状态、术语和可达性,不证明语义一致。