Skip to content

docs: improve product positioning, add FAQ section to README - #71

Merged
EricNGOntos merged 1 commit into
mainfrom
docs/wuchengke/add-benchmark-readme
May 14, 2026
Merged

EricNGOntos merged 1 commit into
mainfrom
docs/wuchengke/add-benchmark-readme

Conversation

@EricNGOntos

Copy link
Copy Markdown
Contributor

Summary

This PR enhances the project README with two key improvements:

1. Product Positioning & Slogan

  • Added a prominent slogan at the top: "We're not building the next document parser — we're building document memory infrastructure that agents can actually consume."
  • Expanded the intro to clarify Knowhere's relationship with open-source parsers (MinerU, Docling, Marker): we stand on their shoulders and actively improve upon them with memory-oriented parsing optimizations and agentic parsing.
  • Rewrote the one-liner to emphasize persistent, navigable memory for AI agents.

2. FAQ Section

Added a "Frequently Asked Questions" module addressing the most common community questions:

  • Is MinerU required? — No, any doc-to-MD tool works; MinerU is just our current best-performing default for PDF/PPT.
  • LLM/VLM dependencies? — DeepSeek for text/hierarchy, Qwen-VL for vision tasks, fully model-agnostic via env vars.
  • Agentic vs Traditional RAG? — Explains hierarchical navigation vs flat vector lookup.
  • Multi-modal support? — Images/tables extracted, summarized via VLM, and explicitly linked to source text chunks.

3. Benchmark Expansion Note

Added a [!NOTE] callout indicating benchmarks are actively expanding beyond the current MinerU baseline.

All changes are documentation-only (README.md). No code changes.

@EricNGOntos EricNGOntos added the documentation Improvements or additions to documentation label May 14, 2026
@EricNGOntos EricNGOntos self-assigned this May 14, 2026
@EricNGOntos
EricNGOntos merged commit 3a8c89a into main May 14, 2026
7 checks passed
@EricNGOntos
EricNGOntos deleted the docs/wuchengke/add-benchmark-readme branch May 14, 2026 15:25
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