Repository navigation
docs: rewrite README and add English version - #1
Merged
Merged
Conversation
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
1 participant
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.
Rewrite the Chinese README from the implementation and add a matching English README so users can understand the project and follow a staged setup from keyword search to local model answers and optional vector retrieval.
Both documents cover configuration loading, architecture, APIs, development checks, and current limitations, including citation verification and retrieval-only evaluation metrics. This PR changes only README.md and README-en.md.
Validation: relative links, shell and request JSON syntax, bilingual command consistency, API routes, configuration defaults, evaluation flags, and git diff --check passed. Branch CI passed for 0bff2b5. A full local startup and live model integration were not run because application dependencies are unavailable in the local environment.