Skip to content

Make the README a short, uniform guide for newcomers - #39

Merged
liran merged 4 commits into
mainfrom
docs/readme-template
Nov 4, 2026
Merged

liran merged 4 commits into
mainfrom
docs/readme-template

Conversation

@liran

@liran liran commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

The README was a few very long paragraphs, so a first install meant reading all of them. It now uses the same seven sections as the other Weir repositories, states what the chart provides and what you provide, and walks through one install, including the client label and address that a first user would otherwise miss.

The configuration, monitoring, autoscaling, operations and development detail moved to docs/, with headings added, one sentence moved under a better heading and the SDK version updated to v0.23.1, the first licensed release. Validation: make test passes and helm template renders the quick start. Remaining gap: it has not been applied to a real cluster, and chart CI installs only the Search example.

@liran liran self-assigned this Nov 4, 2026
@liran
liran merged commit 3eecfa4 into main Nov 4, 2026
2 checks passed
@liran
liran deleted the docs/readme-template branch November 4, 2026 13:15
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