Skip to content

docs(readme): replace the install, port and action-input tables with sentences - #687

Merged
bmscomp merged 1 commit into
mainfrom
docs/readme-fewer-tables
Nov 17, 2026
Merged

bmscomp merged 1 commit into
mainfrom
docs/readme-fewer-tables

Conversation

@bmscomp

@bmscomp bmscomp commented Nov 17, 2026

Copy link
Copy Markdown
Owner

The README's three reference tables become short sentences:

  • What kates deploy installs: one sentence naming the components. Namespaces are configurable, and kates deploy --dry-run prints every release and namespace.
  • Reach the services: kates ports exposes the services and prints each local URL; the two-forwarder port map and its footnote are gone. The Grafana sign-in on Kind stays.
  • GitHub Action: the example already shows the common inputs; the rest point to action.yml, which describes each one.

Docs only, no code change.

…sentences

The components list, the port map and the action inputs each become a
sentence. Namespaces are configurable and shown by kates deploy --dry-run,
local URLs are printed by kates ports, and every action input is described
in action.yml.
@bmscomp
bmscomp merged commit 599d997 into main Nov 17, 2026
62 checks passed
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