Skip to content

docs(readme): add zero-key quickstart - #365

Merged
himanshu231204 merged 1 commit into
OpenAgentHQ:mainfrom
xianjianlf2:docs/zero-key-quickstart
Aug 31, 2026
Merged

docs(readme): add zero-key quickstart#365
himanshu231204 merged 1 commit into
OpenAgentHQ:mainfrom
xianjianlf2:docs/zero-key-quickstart

Conversation

@xianjianlf2

Copy link
Copy Markdown
Contributor

Summary

  • add a copy-pasteable offline quickstart immediately after installation
  • use the built-in mock LLM and retriever with a minimal dataset
  • show the full dataset → retrieval → generation → metrics → report path before API-key setup

Verification

  • copied the documented files into a clean directory
  • oaeval validate quickstart.yaml passed with no API keys
  • oaeval run quickstart.yaml completed with 1 item and 0 errors
  • uv run pytest tests/integration/test_pipeline/test_mock_e2e.py (3 passed)

Repository-wide Ruff, mypy, and pytest currently fail on pre-existing main-branch issues (36 lint errors, 163 type errors, and missing numpy during test collection); this README-only change does not touch those paths.

Closes #331

Implementation and validation were assisted by OpenAI Codex; I reviewed the final documentation and executed the snippet end-to-end.

Signed-off-by: MarkXian <mark-xian@foxmail.com>
@himanshu231204
himanshu231204 merged commit f0ffed5 into OpenAgentHQ:main Aug 31, 2026
11 checks passed
@github-actions

Copy link
Copy Markdown

🎉 Congratulations @xianjianlf2!

Your pull request has been successfully merged into main. 🚀

Thank you for contributing to OpenAgentHQ and helping improve the project.

We truly appreciate your contribution and hope to see you back with more amazing PRs!

Happy Open Sourcing! ❤️

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 zero-API-key quickstart using provider: mock

2 participants