Skip to content

docs: README copy overhaul and FAQ restructure - #86

Merged
torinkwok merged 7 commits into
stagingfrom
feat/steve/readme-faq-polish
May 16, 2026
Merged

torinkwok merged 7 commits into
stagingfrom
feat/steve/readme-faq-polish

Conversation

@torinkwok

Copy link
Copy Markdown
Contributor

Summary

  • Rename intro section from "What We Are" to "Overview" with a cleaner, direct opener emphasizing complex, dirty documents
  • Emphasize semantic completeness of chunks and broad RAG compatibility
  • Call out the proprietary Tree-like parsing algorithm and its role in preventing semantic fragmentation
  • Move FAQ up to follow "How it Works"; restructure first entry as "What is Knowhere's relationship with MinerU?"
  • Surface MinerU as the benchmark baseline directly in the performance section body and footnote
  • Replace benchmark chart graphic
  • Remove version release news entry (goes stale with every CI/CD deploy)
  • Fix citation title to match the restored H1 tagline
  • Remove all em dashes; tighten long-form sentences throughout
  • Fix FAQ rendering: add blank lines between Q and A so GitHub renders them as separate paragraphs

Made with Cursor

Steve Kwok and others added 7 commits May 16, 2026 12:24
- 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>
@torinkwok
torinkwok merged commit acc1ade into staging May 16, 2026
7 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.

1 participant