Skip to content

docs: add 30-second quick-start callout above Performance section#29

Open
nuthalapativarun wants to merge 1 commit into
microsoft:mainfrom
nuthalapativarun:feat/20-quick-start-callout
Open

docs: add 30-second quick-start callout above Performance section#29
nuthalapativarun wants to merge 1 commit into
microsoft:mainfrom
nuthalapativarun:feat/20-quick-start-callout

Conversation

@nuthalapativarun
Copy link
Copy Markdown

Problem

Issue #20 notes that new users hit ~160 lines of motivation text, architecture comparisons, and benchmark tables before reaching the Quick Start section. First-time visitors who want to just try the tool have no fast path.

Fix

Insert a short "⚡ 30-second start" section immediately after the Demo video and before the Performance section. It contains a four-line copy-paste snippet (install, browser, API key, run command) and a link down to the full Quick Start section for users who want the complete guide.

Changes

  • README.md — added ## ⚡ 30-second start block (14 lines) between the Demo and Performance sections; no existing content removed or restructured

Not affected

  • The existing ## 🚀 Quick Start section — not touched; the callout links to it
  • All Python source files — not touched

Closes #20

New users hit ~160 lines of motivation, comparisons, and benchmarks
before reaching the Quick Start section. Add a short TL;DR code block
immediately after the demo video so first-time visitors can copy-paste
and run without scrolling. Links back to the full Quick Start section
for the complete setup guide.

Closes microsoft#20
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.

Improve onboarding clarity: missing quick-start path for new users

1 participant