oterm/mkdocs.yml
Yiorgis Gozadinos 0a1dc37157
Bring docs in sync with the pydantic-ai refactor
Drop Ollama-only framing across index, README, and project metadata —
oterm now talks to Ollama, OpenAI, Anthropic, Google, Groq, Mistral,
Cohere, Bedrock, DeepSeek, Cerebras, Grok, Hugging Face, and any
OpenAI-compatible runner (vLLM, LM Studio, llama.cpp, OpenRouter,
LiteLLM, …). Add a Providers / API keys table to app_config.md so the
provider→env-var mapping lives somewhere discoverable, plus a small
Ollama-specific env-var sub-table.

Trim parameters.md to the parameters the chat-edit modal actually
exposes (temperature, top_p, max_tokens) and remove the gone format /
structured-output bullet. Note that provider and model both lock once a
chat starts. In commands.md, drop the format reference from the
Edit chat parameters description, generalise the inference-cancel note
away from Ollama, and round out the Edit description with tools and
thinking. Also update mkdocs.yml site_description and the pyproject.toml
description (these surface on the docs site and PyPI / Homebrew).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-25 10:33:46 +03:00

81 lines
2 KiB
YAML

site_name: oterm
site_description: the terminal client for Ollama, OpenAI, Anthropic, and any pydantic-ai-supported provider.
site_url: https://ggozad.github.io/oterm/
theme:
name: material
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/lightbulb-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: deep purple
accent: amber
toggle:
icon: material/lightbulb
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep purple
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to system preference
features:
- content.code.annotate
- content.code.copy
- content.code.select
- content.footnote.tooltips
- content.tabs.link
- content.tooltips
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.path
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
icon:
repo: fontawesome/brands/github-alt
# logo: img/icon-white.svg
# favicon: img/favicon.png
language: en
repo_name: ggozad/oterm
repo_url: https://github.com/ggozad/oterm
plugins:
# Material for MkDocs
search:
nav:
- oterm:
- index.md
- Installation: installation.md
- Commands & shortcuts: commands.md
- Chat parameters: parameters.md
- Model Context Protocol:
- mcp/index.md
- Tools:
- tools/index.md
- Configuration: app_config.md
- Debugging / Development: development/index.md
- RAG example: rag_example.md
markdown_extensions:
- admonition
- attr_list
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
use_pygments: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences