Skip to content

docs: Update README benchmark graphic and performance copy - #77

Merged
EricNGOntos merged 1 commit into
stagingfrom
docs/wuchengke/benchmark-readme-update
May 15, 2026
Merged

EricNGOntos merged 1 commit into
stagingfrom
docs/wuchengke/benchmark-readme-update

Conversation

@EricNGOntos

Copy link
Copy Markdown
Contributor

Closes #76

Summary of Changes

This PR updates the README benchmark section with two targeted improvements:

1. New Benchmark Graphic ()

The previous graphic () has been replaced with an updated version that more clearly communicates the performance gap between Knowhere and alternatives. The new image uses a cleaner visual design consistent with the existing documentation assets.

2. Refined Benchmark Copy

The description has been updated to be more precise and compelling:

  • Before: Generic language about "efficiency and accuracy" with broad comparisons to "raw documents or generic parsers".
  • After: Specifically highlights real-world agent task performance improvements across the three core operations users care about: searching, modifying, and answering. The comparison baseline is also clarified: Knowhere vs raw documents or .md/.json outputs from other parsers.

Testing

  • Verified the img src attribute in README.md correctly references docs/assets/benchmark.png.
  • Confirmed the old benchmark-performance.png is removed from the repo.
  • README renders correctly on GitHub with the updated image and copy.

- Replace benchmark-performance.png with benchmark.png (updated visual)
- Refine benchmark section copy: emphasize real-world task accuracy
  (searching, modifying, answering) vs raw docs and generic parser outputs
- Fix img src reference in README to match new filename

Closes #76
@EricNGOntos EricNGOntos added the documentation Improvements or additions to documentation label May 15, 2026
@EricNGOntos EricNGOntos self-assigned this May 15, 2026
@EricNGOntos
EricNGOntos merged commit 9e8a3f9 into staging May 15, 2026
7 checks passed
@EricNGOntos
EricNGOntos deleted the docs/wuchengke/benchmark-readme-update branch May 15, 2026 04:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant