Skip to content

docs(examples): highlight local-only examples#74

Open
wananing wants to merge 1 commit into
ob-labs:mainfrom
wananing:docs/local-only-examples
Open

docs(examples): highlight local-only examples#74
wananing wants to merge 1 commit into
ob-labs:mainfrom
wananing:docs/local-only-examples

Conversation

@wananing

Copy link
Copy Markdown
Contributor

Summary

Highlight examples that can run without external services.

Fixes #58.

Solution Description

This PR adds a short section to examples/README.md listing examples that do not require OceanBase, LLM API keys, or
background services.

The section includes exact commands and expected behavior for:

  • examples/basic/pipeline_file.py
  • examples/basic/langchain.py
  • examples/advanced/research_agent.py
  • examples/advanced/evidence_chain.py
  • examples/advanced/powermem_minimal.py
  • examples/advanced/powermem_plug.py with USE_POWERMEM=mock

It also notes that the SUMMARIZER_PROVIDER not configured warning is expected in local zero-config mode.

Verified with:

  • git diff --check
  • Ran each listed command locally

List examples that run without OceanBase, LLM API keys, or background services, including exact commands and expected behavior.

Fixes ob-labs#58.
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.

Document examples that run without external services

1 participant