Skip to content

docs: README rewrite, logo and banner - #26

Merged
eksrha merged 1 commit into
mainfrom
docs/readme-and-branding
Nov 3, 2026
Merged

eksrha merged 1 commit into
mainfrom
docs/readme-and-branding

Conversation

@eksrha

@eksrha eksrha commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

What

  • New README: banner, badges, short pitch, highlights, architecture sketch, quick start (local mock run and Helm from the OCI registry), API table, security section with the cosign verify command.
  • Logo and banner under assets/ (SVG logo, small-size icon, icon tile, light and dark lockups, banner.png).
  • The long tuning and sizing sections moved verbatim to docs/tuning.md; new docs/configuration.md with all environment variables (including the *_MAX_CONCURRENT bounds that were undocumented), backpressure, health endpoints and metrics.
  • AGENTS.md: fixed stale statements (Go version, reranker runs on TEI) and added the concurrency variables.

No workflow, chart or code files changed, so no component release is triggered.

@github-actions

github-actions Bot commented Nov 3, 2026

Copy link
Copy Markdown
Possible relctl commands for this Pull Request

Version scheme: calver. The version of the release is the date of the release (YYYYMM.D.N, N counts the releases of that day). Branch prefixes and comment commands have no effect.

Need more help?

Have a look at my repo

This message was created by relctl and can be disabled by the env variable RELCTL_SILENT=true

@eksrha
eksrha merged commit 195dcca into main Nov 3, 2026
3 checks passed
@eksrha
eksrha deleted the docs/readme-and-branding branch November 3, 2026 09:43
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