Skip to content

docs: README copy overhaul, FAQ restructure, and benchmark update - #87

Merged
torinkwok merged 10 commits into
mainfrom
staging
May 16, 2026
Merged

torinkwok merged 10 commits into
mainfrom
staging

Conversation

@torinkwok

Copy link
Copy Markdown
Contributor

Summary

  • Restore original H1 tagline: "Prepare unstructured data for AI Agents"
  • Rename intro section to "Overview"; sharpen opener to emphasize complex, dirty documents
  • Emphasize semantic completeness of chunks and broad RAG compatibility
  • Call out the proprietary Tree-like parsing algorithm and semantic fragmentation prevention
  • Move FAQ up to follow "How it Works"; lead with "What is Knowhere's relationship with MinerU?"
  • Surface MinerU as the benchmark baseline in the performance section
  • Replace benchmark chart graphic
  • Remove stale version release news entry
  • Fix citation title to match H1
  • Remove all em dashes; rewrite long-form sentences to be concise throughout
  • Fix FAQ rendering: blank lines between Q and A

Closes #80

Made with Cursor

Steve Kwok and others added 10 commits May 16, 2026 12:18
- Restore original H1 tagline ("Prepare unstructured data for AI Agents")
- Rewrite "What We Are" with a direct, positive opener; remove defensive
  parser comparison from the intro
- Remove TIP callout mentioning MinerU from the intro section; move
  the relationship context to the FAQ and benchmark sections where it
  fits naturally
- Rewrite Chengke's long-form sentences into concise, punchy copy
  throughout (What We Are, How it Works, Performance Benchmark, FAQ)
- Remove all em dashes across the file
- Add "What is Knowhere's relationship with MinerU?" as the first FAQ entry
- Surface MinerU as the benchmark baseline in the performance section body
  and footnote

Co-authored-by: Cursor <cursoragent@cursor.com>
- Add context to "How it Works" opener for smoother flow after What We Are
- Move FAQ section up to follow How it Works; rename to "## FAQ"
- Reframe first FAQ entry as "What is Knowhere's relationship with MinerU?"
- Fix citation title to match restored H1 tagline

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
…tion

- Strengthen "What We Are" opener to emphasize complex, dirty documents
- Call out the proprietary Tree-like parsing algorithm in How it Works
- Note that it prevents semantic fragmentation across chunks

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
docs: README copy overhaul and FAQ restructure
Co-authored-by: Cursor <cursoragent@cursor.com>
@torinkwok
torinkwok merged commit a52cb1b into main May 16, 2026
9 checks passed
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.

Why was the README banner removed? It's a strong visual hook for the project.

1 participant