vikingowl
5b202fed4f
- Include detailed architecture overview in `docs/architecture.md`. - Add `docs/configuration.md`, detailing configuration file structure and settings. - Provide a step-by-step provider implementation guide in `docs/provider-implementation.md`. - Add frequently asked questions (FAQ) document in `docs/faq.md`. - Create `docs/migration-guide.md` for future breaking changes and version upgrades. - Introduce new examples in `examples/` showcasing basic chat, custom providers, and theming. - Add a changelog (`CHANGELOG.md`) for tracking significant changes. - Provide contribution guidelines (`CONTRIBUTING.md`) and a Code of Conduct (`CODE_OF_CONDUCT.md`).
13 lines
665 B
Markdown
13 lines
665 B
Markdown
# Owlen Core
|
|
|
|
This crate provides the core abstractions and data structures for the Owlen ecosystem.
|
|
|
|
It defines the essential traits and types that enable communication with various LLM providers, manage sessions, and handle configuration.
|
|
|
|
## Key Components
|
|
|
|
- **`Provider` trait**: The fundamental abstraction for all LLM providers. Implement this trait to add support for a new provider.
|
|
- **`Session`**: Represents a single conversation, managing message history and context.
|
|
- **`Model`**: Defines the structure for LLM models, including their names and properties.
|
|
- **Configuration**: Handles loading and parsing of the application's configuration.
|