Skip to content

Lead the README with what the product does and how to use it - #2

Merged
PradipNichite merged 1 commit into
mainfrom
docs/readme-product-first
Oct 23, 2026
Merged

PradipNichite merged 1 commit into
mainfrom
docs/readme-product-first

Conversation

@PradipNichite

Copy link
Copy Markdown
Contributor

Repositions the README so a visitor first learns what Document Intelligence does and how to use it; the AI Demos research story stays, but secondary.

  • Opening: what it does (extract fields into tables, Knowledge View, RAG), the three ways in (Try the Live Application → the FutureSmart landing page, View Installation Guide, Explore the API), and Open source · Apache-2.0 · Self-hostable · API accessible.
  • New sections: "What you can do" (extraction, Knowledge View, question answering, APIs) and "Who it is for".
  • Short research section linking the improvement history, then the three existing screenshots in the established order.
  • Moved, not changed: the detailed "search that left its scope" example and the published-so-far line now sit below the architecture section under "How research findings become fixes". No verdict, history entry, install step or known limit changed.

🤖 Generated with Claude Code

Opens with what Document Intelligence does, the three ways to use it (live
application, self-hosted install, API), what you can do, and who it is for,
then a short research section linking the improvement history, then the
screenshots. The detailed AI Demos engineering example moves below the
architecture section, unchanged. Verdicts and history untouched.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@PradipNichite
PradipNichite merged commit 74dca58 into main Oct 23, 2026
4 checks passed
@PradipNichite
PradipNichite deleted the docs/readme-product-first branch October 23, 2026 14:41
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