Skip to content

docs: update README for latest features - #9

Merged
Attacker687 merged 1 commit into
mainfrom
docs/update-readme-20260712
Jul 12, 2026
Merged

docs: update README for latest features#9
Attacker687 merged 1 commit into
mainfrom
docs/update-readme-20260712

Conversation

@Attacker687

Copy link
Copy Markdown
Owner

Summary

  • update the feature overview for document preview, QA history, and mind maps
  • document current mind map APIs and document operations
  • align the technology stack and architecture diagram with the implementation
  • refresh testing and troubleshooting guidance

Verification

  • backend: 46 tests passed
  • frontend: npm ci and npm run build passed (existing chunk-size warnings remain)

@Attacker687
Attacker687 merged commit 7b85511 into main Jul 12, 2026
1 check passed
@Attacker687
Attacker687 deleted the docs/update-readme-20260712 branch July 12, 2026 07:51

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refreshes the project’s README to reflect recently implemented product capabilities (document preview, QA history, mind maps), current API surface, and updated architecture/testing/troubleshooting guidance.

Changes:

  • Expanded the “功能概览” and “使用流程” sections to include document library/preview, QA history viewing, and mind map generation & interaction flows.
  • Updated the API table to document current document operations and mind map endpoints.
  • Adjusted the tech stack and architecture diagram to match the current frontend dependencies and backend responsibilities, and refreshed test/troubleshooting notes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants