Skip to content

docs(providers): align setup guidance - #434

Open
deepujain wants to merge 1 commit into
NVIDIA:mainfrom
deepujain:docs/433-provider-setup
Open

docs(providers): align setup guidance#434
deepujain wants to merge 1 commit into
NVIDIA:mainfrom
deepujain:docs/433-provider-setup

Conversation

@deepujain

Copy link
Copy Markdown
Contributor

Summary

  • Align .env.example, the README provider reference, and the development setup guide with the provider selector on current main.
  • Document the dedicated Ollama, Azure OpenAI, generic OpenAI-compatible, and Gemini CLI setup paths.
  • Preserve existing provider behavior; this PR changes setup guidance only.

Validation

  • Compared every documented provider name, credential variable, endpoint default, and model default against the corresponding implementation under src/skillspector/providers/.
  • Verified all eleven usable provider names and the new provider-specific variables occur in .env.example, README.md, and docs/DEVELOPMENT.md.
  • pytest -m 'not integration and not provider' tests/ -q — 2,825 passed, 13 skipped, 38 deselected, 4 xfailed.
  • ruff check src tests — passed.
  • ruff format --check src tests — 193 files already formatted.
  • git diff --check — passed.
  • Inspected the Markdown tables and fenced setup examples in source; no local Markdown renderer is configured in the repository.

Risk

  • Low: documentation and the example environment template only; runtime provider selection and request behavior are unchanged.
  • Live-provider tests were not run because no provider code changed.

Fixes #433

Signed-off-by: Deepak Jain <deepujain@gmail.com>
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.

Provider setup docs omit supported backends

1 participant