docs: sync documentation with current progress - #12
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR synchronizes repository documentation with the current implementation progress, especially around the “知识地图” (mind map) feature set, updated API surface, and supporting developer/deployment docs.
Changes:
- Expanded and clarified feature lists, troubleshooting guidance, and “current status / next plan” sections to match the latest backend/frontend capabilities.
- Added/updated API documentation for knowledge map workflows (async jobs + debug sync endpoint) and document content preview endpoint.
- Introduced new documentation entry points (frontend/backend/database/docs navigation + Wiki home draft) to make project docs easier to navigate.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates top-level feature list, API endpoint summary, troubleshooting, and doc links to reflect current progress. |
| frontend/README.md | Adds a dedicated frontend developer doc covering routes, local dev, mind map UX, and security notes. |
| docs/需求分析.md | Updates requirements + adds “当前实现状态” snapshot aligned with current delivered features. |
| docs/生成侧接口约定.md | Refreshes generation-side contracts, removes legacy header usage notes, and documents mind map LLM boundaries. |
| docs/wiki/Home.md | Adds a comprehensive Wiki home draft describing architecture, flows, API overview, and progress. |
| docs/README.md | Adds documentation navigation + mapping between docs and implementation status. |
| docs/API接口设计.md | Updates API overview and adds detailed mind map + document content endpoint documentation. |
| database/README.md | Documents DB responsibilities, migrations, Chroma linkage, and mind map JSON compatibility details. |
| backend/README.md | Expands backend module map, configuration, dev commands, testing notes, and mind map behavior overview. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
276
to
277
| | `POST` | `/api/mind-maps/jobs` | 创建导图生成任务 | | ||
| | `GET` | `/api/mind-maps/jobs/{id}` | 查询任务进度 | |
| - 上传接口超时为 5 分钟，并通过 Axios 事件显示真实上传进度。 | ||
| - 若上传响应超时，先到文档库确认是否已创建记录，避免重复提交。 | ||
| - 状态轮询遇到临时网络错误会继续重试。 | ||
| - 原文预览通过受保护的 `/api/documents/{id}/content` 获取，不直接公开上传目录。 |
G-Ethan007
approved these changes
Jul 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.