51 lines
2.4 KiB
Markdown
51 lines
2.4 KiB
Markdown
# Promptkit Rakestrawhome Catalog
|
|
|
|
This repository publishes immutable Rakestrawhome catalog assets for Promptkit.
|
|
It supplies catalog data only; it does not implement provider behavior, load
|
|
credentials, or make network requests.
|
|
|
|
Promptkit owns catalog parsing, validation, runtime behavior, credential
|
|
handling, and consumer documentation. This module owns the Rakestrawhome
|
|
backend definition and its maintained profile data. Consumers should use versions
|
|
chosen by their Promptkit release rather than treating this module as a
|
|
standalone runtime integration.
|
|
|
|
The profile asset originated in Promptkit. Its copyright holder has
|
|
authorized its distribution under MIT along with this repository's Go code
|
|
and documentation.
|
|
|
|
## Compatibility
|
|
|
|
This compatibility policy applies to the `/v3` module. Catalog profiles track
|
|
upstream availability and may be added, removed, renamed, or modified without
|
|
deprecation or advance notice. Consumers that need a particular profile set
|
|
should use the catalog version selected by their Promptkit release.
|
|
|
|
Backend definitions, the exported Go API, and the catalog asset format do
|
|
not share that profile-data exception. Their compatibility follows the normal
|
|
semantic-versioning rules. Published v1 and `/v2` releases retain their historical
|
|
contracts; this README does not retroactively alter them.
|
|
|
|
The `/v3` module replaces the `/v2` manifest and flat profile document with
|
|
ordinary keyed ConfigKit inputs: `catalog/backend.yml` defines
|
|
`backends.rakestrawhome`, and the file under `catalog/profiles/` defines its
|
|
literal ID beneath `profiles`. Profile inheritance uses `extends` instead of
|
|
`base_profile`. This asset-format change is incompatible with `/v2` consumers;
|
|
they should remain on a published `/v2` version. The exported `FS` and `Root`
|
|
remain the asset access surface.
|
|
|
|
Catalog releases use dated versions in the form `v3.YYYYMMDD.N`. The date
|
|
identifies when the catalog snapshot was published in UTC; it does not certify
|
|
that a provider currently offers a model or endpoint named by the data.
|
|
|
|
## Validation and releases
|
|
|
|
Run the offline Go tests, race tests, vet, build, formatting, hygiene, and
|
|
module-resolution checks before release. The complete source-only release
|
|
procedure is in [docs/release.md](docs/release.md).
|
|
|
|
## License
|
|
|
|
This catalog is licensed under the [MIT License](COPYRIGHT).
|
|
The complete license text is available in [LICENSE](LICENSE).
|