docs: research-focused README rewrite, Mermaid diagrams, SOTA table, LICENSE copyright#62
Merged
Conversation
CodeNinjaSarthak
commented
Apr 9, 2026
CodeNinjaSarthak
commented
Owner
- Replace ASCII pipeline with Mermaid flowcharts (ingestion + retrieval)
- Update evaluation to n=1540 across 10 conversations
- Add SOTA comparison table and retrieval architecture diagram
- Replace Quick Start with Reproduce Results section
- Shrink project structure, remove Configuration and Contributing sections
- Add Citation section (EMNLP 2026 under review)
- Sync .env.development.example with missing keys (JINA_API_KEY, AZURE_EMBEDDING_API_VERSION)
- Set LICENSE copyright to 2026 Sarthak
- Fix ruff F541: remove extraneous f-string prefix in eval script
…LICENSE copyright - Replace ASCII pipeline with Mermaid flowcharts (ingestion + retrieval) - Update evaluation to n=1540 across 10 conversations - Add SOTA comparison table and retrieval architecture diagram - Replace Quick Start with Reproduce Results section - Shrink project structure, remove Configuration and Contributing sections - Add Citation section (EMNLP 2026 under review) - Sync .env.development.example with missing keys (JINA_API_KEY, AZURE_EMBEDDING_API_VERSION) - Set LICENSE copyright to 2026 Sarthak - Fix ruff F541: remove extraneous f-string prefix in eval script
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.