Skip to content

Describe every way to use LocalDeploy, not only the OpenAI-compatible API - #101

Merged
oney-erge merged 2 commits into
mainfrom
docs/ways-to-use-it
Nov 20, 2026
Merged

oney-erge merged 2 commits into
mainfrom
docs/ways-to-use-it

Conversation

@oney-erge

Copy link
Copy Markdown
Owner

What changed

The README, docs/API_OPTIONS.md, AGENTS.md and the package description described LocalDeploy as a web UI plus an OpenAI-compatible API. The code ships more than that, and a visitor could not tell.

  • README: the opening says what it does (find models that fit, test them on your own questions, connect the winner to your apps). New Ways to use it table covers the web UI, the OpenAI-compatible API, the native API (/chat, /vision, /estimate, /benchmark), the control API (about 50 endpoints, reference at /docs), the decision API, generated client setups (Open WebUI, AnythingLLM, Continue, Cline, curl, Python, JavaScript, Docker Compose), deployment manifests, and the terminal helpers. New Where it fits section. The decision-model paragraph now carries the measured result and links to the raw runs.
  • docs/API_OPTIONS.md: opens with a table of the four API families instead of "native or OpenAI-compatible".
  • AGENTS.md and pyproject.toml: the one-line description names the same surface.

Every claim was checked against the routes in localdeploy/server.py and localdeploy/control/. The decision-model numbers are copied from benchmarks/decision-routing/README.md. llmfit and other tools are deliberately not named.

Verification

  • pytest tests/test_documentation.py tests/test_packaging.py: 10 passed, 3 skipped (Unix launcher tests, on Windows)
  • git diff --check: clean; no em dashes in the changed files
  • uv build and twine check: the sdist passes with the new description and README

Not run: the full suite (no Python behavior changed).

Notes

Merge before the 0.7.0 release so the PyPI page shows the new README.

oney-erge and others added 2 commits November 20, 2026 00:36
… API

The README, the API guide, the package description and the agent notes named
the web UI and the OpenAI-compatible API. The code also ships a native API,
a control API of about 50 endpoints, the decision API, deployment manifests,
and generated setups for eight clients. Add a Ways to use it table, a Where it
fits section, and the measured decision-model result, and list all four API
families at the top of the API guide.
@oney-erge
oney-erge merged commit 8e434ea into main Nov 20, 2026
9 checks passed
@oney-erge
oney-erge deleted the docs/ways-to-use-it branch November 20, 2026 16:34
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