Skip to content

Release 0.1.1: Documentation fixes and cleanup#12

Merged
yfedoseev merged 15 commits intomainfrom
release/0.1.1
Jan 13, 2026
Merged

Release 0.1.1: Documentation fixes and cleanup#12
yfedoseev merged 15 commits intomainfrom
release/0.1.1

Conversation

@yfedoseev
Copy link
Copy Markdown
Owner

Summary

  • Fix incorrect package names in installation instructions (llmkit-python, llmkit-node)
  • Enhance READMEs with production focus and "Why LLMKit?" sections
  • Clean up documentation by removing internal development notes
  • Rewrite PROVIDERS.md and MODELS_REGISTRY.md for better readability

Changes

Fixed

  • Package names: Corrected installation instructions in READMEs
    • Python: pip install llmkit-python (was incorrectly llmkit)
    • Node.js: npm install llmkit-node (was incorrectly llmkit)
  • Badge URLs: Fixed PyPI and npm badge links in main README

Documentation

  • Enhanced READMEs with "Why LLMKit?" section highlighting Rust benefits
  • Added production features overview (smart router, circuit breaker, guardrails)
  • Improved code examples for prompt caching, extended thinking, and model registry
  • Cleaned up internal development notes from documentation
  • Simplified PROVIDERS.md and MODELS_REGISTRY.md for better readability
  • Removed internal research docs (moved to model_registry repo)

Test plan

  • Verify installation commands work correctly
  • Review documentation for accuracy

- Add 'Why LLMKit?' section highlighting Rust benefits
- Emphasize production-ready features (memory safety, no GIL, no leaks)
- Add prompt caching examples with 90% cost savings messaging
- Add extended thinking, model registry examples
- Fix badge URLs (llmkit-python, llmkit-node)
- Add production features table (smart router, circuit breaker, guardrails)
- Improve code examples with cleaner imports for Node.js
- Remove internal 'Phase' development notes
- Create clean, user-friendly provider documentation
- Organize 100+ providers by category (Cloud, Inference, Regional, etc.)
- Add environment variables and features for each provider
- Rewrite model registry with practical examples
- Add popular models table with pricing
- Add capability query examples
- Remove docs with internal "Phase" references (moved to model_registry):
  - additional_providers.md
  - emerging_specialized_providers.md
  - domain_models.md
  - scientific_benchmarks.md

- Rewrite CHANGELOG.md with standard Keep a Changelog format
- Simplify RELEASE_NOTES.md to user-facing release notes
- Update docs/INDEX.md to remove references to deleted files
- Updated model data from model_registry crawler (97 providers, 11,067 models)
- Refreshed pricing, capabilities, and benchmark data
- Synchronized with latest provider API changes
- Update Cargo.toml versions (main, python, node)
- Update pyproject.toml version
- Update package.json version
- Update CHANGELOG.md with 0.1.1 release notes
Word and TranscribeResponse are returned from API calls and cannot be
instantiated directly in tests (no #[new] constructor in PyO3 bindings).
The tests were passing - the CI failure was a Rust toolchain issue,
not Python test failures.
The cargo-deny-action v2 runs in a musl container which conflicted
with rust-toolchain.toml causing:
  error: override toolchain 'stable-x86_64-unknown-linux-musl' is not installed

Installing the stable toolchain explicitly before running cargo-deny
resolves the conflict.
The model alias 'gpt-4o' is shared by multiple providers (OpenAI, OpenRouter).
The last provider in the registry wins the alias lookup. Using the full ID
'openai/gpt-4o' ensures the test checks the correct provider.
When multiple providers offer the same model (e.g., gpt-4o via OpenAI,
Azure, OpenRouter), aliases now resolve to the native provider:
- gpt-4o → openai/gpt-4o (not azure or openrouter)
- claude-sonnet-4-5 → anthropic/claude-sonnet-4-5

Added is_native_provider() function to identify canonical providers
for model families (OpenAI for GPT/O1/O3, Anthropic for Claude, etc.)

Also fixes raw_id collision where openrouter/gpt-4o's raw_id "gpt-4o"
was overwriting the OpenAI entry.
The test was checking for docs/domain_models.md and docs/scientific_benchmarks.md
which were moved to ~/projects/model_registry as part of documentation cleanup.

Updated to check for core docs that actually exist:
- docs/INDEX.md
- docs/MODELS_REGISTRY.md
- docs/getting-started-rust.md
Emphasize 100+ providers and 11,000+ models across all packages.
@yfedoseev yfedoseev merged commit 330e105 into main Jan 13, 2026
45 checks passed
@yfedoseev yfedoseev deleted the release/0.1.1 branch January 13, 2026 07:01
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