Skip to content

docs: lead Quickstart with pytest path and expected output - #7

Closed
AshSgDe29071999 wants to merge 2 commits into
AgentPostmortem:mainfrom
AshSgDe29071999:docs/quickstart-pytest-first
Closed

docs: lead Quickstart with pytest path and expected output#7
AshSgDe29071999 wants to merge 2 commits into
AgentPostmortem:mainfrom
AshSgDe29071999:docs/quickstart-pytest-first

Conversation

@AshSgDe29071999

@AshSgDe29071999 AshSgDe29071999 commented Aug 10, 2026

Copy link
Copy Markdown

Summary

Improves the README Quickstart so the first copy-paste path is offline pytest -q with concrete expected output, plus a shaped hash-embedder benchmark table, before model-download commands.

What readers get

  • Install + pytest -q with the expected dots/[100%] line
  • Offline tenantq benchmark --embedder hash with the real report shape (modes, columns)
  • Full fastembed path and a sample search command after that

Test plan

  • Docs-only; commands match project layout and a local hash benchmark run

Fixes #1

AshSgDe29071999 and others added 2 commits August 10, 2026 09:43
First-run should not require embedding downloads. Add pytest -q and the
expected green outcome before the full benchmark commands.

Fixes #1
Add pytest dots output and a shaped benchmark table so first-run
readers know what success looks like without downloading models.

Fixes #1
@royalpinto007

Copy link
Copy Markdown
Collaborator

Thanks! Could you fix the Quickstart so the documented search command works after the benchmark, and update the expected pytest output to match the current seven tests? Please ping me once updated.

@AshSgDe29071999 AshSgDe29071999 closed this by deleting the head repository Aug 11, 2026
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.

Add a copy-paste quickstart to the README

2 participants