开发与贡献

先确认要参与哪个仓库复制小节链接

• KnowRealm-AI：桌面产品、业务服务与助手。
• knowrealm-ai-website：官网、下载入口和这套公开文档。

下面的启动步骤针对桌面产品。文档编辑方法见本页末尾。

准备桌面开发环境复制小节链接

需要 Git、Node.js 与 pnpm、Python 3.12 或以上与 uv，以及 Tauri Windows 开发所需的 Rust、Microsoft C++ 构建工具和 WebView2 环境。具体版本约束以仓库清单和锁文件为准。

普通用户不需要这些开发依赖，直接安装 MSI即可。

获取并启动产品复制小节链接

git clone https://github.com/youyu-youth/KnowRealm-AI.git
cd KnowRealm-AI
git switch main
pnpm install --frozen-lockfile
cd backend
uv sync --frozen
cd ..
pnpm --filter @knowrealm/desktop tauri dev

桌面启动命令负责准备音频处理程序并拉起本地服务。首次运行需要网络和相应构建环境。不要对自己的日常数据目录同时启动另一份服务；调试与验收使用独立数据目录。

启动成功后应出现桌面窗口与首启向导。AI 功能仍需要你自己的服务配置，安装开发依赖不会提供模型额度。

修改前阅读复制小节链接

阅读仓库的 AGENTS.md、PROJECT_PROGRESS.md 和 GLOSSARY.md。进入桌面端或后端后继续阅读该目录规则，按修改范围查需求和架构决策。

前端 workspace 与后端依赖分别管理。变更接口时同步契约与调用方；UI 文案同时维护中文和英文。测试使用仓库当前的 docs/agents/validation.md 统一入口。

报告问题与提交贡献复制小节链接

在 Issues 中说明应用版本、系统、复现步骤、预期与实际结果。日志和截图应去除密钥及个人资料。

提交改动时保持范围集中，说明行为变化、实际执行的检查和仍未验证的部分。涉及模型、设备或系统缩放时，分别记录验证环境。

编辑官网文档复制小节链接

文档正文位于官网仓库的 content/docs/，采用 MDX；meta.json 维护目录顺序与分组。Fumadocs 负责正文渲染、全文搜索、页内目录与前后篇导航。

git clone https://github.com/youyu-youth/knowrealm-ai-website.git
cd knowrealm-ai-website
pnpm install --frozen-lockfile
pnpm dev

编辑后检查 pnpm typecheck、pnpm lint 与 pnpm build，并实际打开修改的页面。更新产品能力时，重新核对目标版本源码与发布说明，不把旧文档当作实现证明。