Skip to content

docs: tighten root README prose into bullets and right-size non-env framing - #257

Merged
joshua-temple merged 1 commit into
mainfrom
docs/readme-tighten-prose
Jun 23, 2026
Merged

joshua-temple merged 1 commit into
mainfrom
docs/readme-tighten-prose

Conversation

@joshua-temple

Copy link
Copy Markdown
Collaborator

What

  • Convert the dense multi-sentence prose blocks in the root README into lead-in + bullet lists (How it works, Cross-repo artifact tracking, Hotfix any environment, Is cascade right for your repo, What adopting looks like, Roadmap to stable). Hero/badges, mermaid diagrams, code fences, and tables are untouched.
  • Lightly soften the one discouraging line so a no-deployment repo reads as a supported shape (no-environment mode still gives conventional-commit versioning and releases) rather than being lumped under "overkill." Deliberately a light touch, not a headline.

Verification

  • Docs-only; single file (README.md). Rebased onto current main.
  • Independent review: APPROVE. All 19 links and inline-code tokens preserved across the bullet conversions; fences balanced; the softened line is accurate and does not imply hotfix/rollback for no-env.

…raming

Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
@joshua-temple
joshua-temple enabled auto-merge (squash) June 23, 2026 00:01
@joshua-temple
joshua-temple merged commit 00365f0 into main Jun 23, 2026
12 checks passed
@joshua-temple joshua-temple added the docs Improvements or additions to documentation label Jun 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant